From 8a02b0218f0f11bbfe25303eafe5e33e63726a33 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 9 Aug 2023 11:43:04 -0500 Subject: [PATCH] Update OpenAPI Description (#40484) --- .../fine-grained-pat-permissions.json | 66 +- .../server-to-server-permissions.json | 78 +- .../fine-grained-pat-permissions.json | 66 +- .../server-to-server-permissions.json | 78 +- .../fine-grained-pat-permissions.json | 66 +- .../server-to-server-permissions.json | 78 +- .../fine-grained-pat-permissions.json | 66 +- .../server-to-server-permissions.json | 78 +- .../fine-grained-pat-permissions.json | 66 +- .../server-to-server-permissions.json | 78 +- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 188 +- src/rest/data/ghae/schema.json | 8 +- src/rest/data/ghec-2022-11-28/schema.json | 188 +- .../data/ghes-3.10-2022-11-28/schema.json | 8 +- src/rest/data/ghes-3.8/schema.json | 8 +- src/rest/data/ghes-3.9-2022-11-28/schema.json | 8 +- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 12259 ++++++++++++++++ src/webhooks/data/ghae/schema.json | 8070 ++++++++++ src/webhooks/data/ghec/schema.json | 12259 ++++++++++++++++ src/webhooks/data/ghes-3.10/schema.json | 8070 ++++++++++ src/webhooks/data/ghes-3.7/schema.json | 8070 ++++++++++ src/webhooks/data/ghes-3.8/schema.json | 8070 ++++++++++ src/webhooks/data/ghes-3.9/schema.json | 8070 ++++++++++ src/webhooks/lib/config.json | 2 +- 26 files changed, 65435 insertions(+), 567 deletions(-) diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json index fab4d9313f..1b561ff739 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json @@ -835,6 +835,39 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [], + "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": [], + "access": "read" + }, + { + "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": [], + "access": "write" + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1603,39 +1636,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [], - "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": [], - "access": "read" - }, - { - "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": [], - "access": "write" - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json index e1cacfc715..45c31460d2 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json @@ -1124,6 +1124,45 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [] + }, + { + "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": [] + }, + { + "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": [] + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -2044,45 +2083,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [] - }, - { - "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": [] - }, - { - "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": [] - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.6/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.6/fine-grained-pat-permissions.json index b62517923c..48fc9542b0 100644 --- a/src/github-apps/data/ghes-3.6/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.6/fine-grained-pat-permissions.json @@ -668,6 +668,39 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [], + "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": [], + "access": "read" + }, + { + "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": [], + "access": "write" + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1347,39 +1380,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [], - "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": [], - "access": "read" - }, - { - "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": [], - "access": "write" - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.6/server-to-server-permissions.json b/src/github-apps/data/ghes-3.6/server-to-server-permissions.json index 1f745ab863..d12b792c63 100644 --- a/src/github-apps/data/ghes-3.6/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.6/server-to-server-permissions.json @@ -806,6 +806,45 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [] + }, + { + "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": [] + }, + { + "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": [] + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1619,45 +1658,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [] - }, - { - "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": [] - }, - { - "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": [] - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json index 31f0f41766..165382b012 100644 --- a/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json @@ -722,6 +722,39 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [], + "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": [], + "access": "read" + }, + { + "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": [], + "access": "write" + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1401,39 +1434,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [], - "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": [], - "access": "read" - }, - { - "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": [], - "access": "write" - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.7/server-to-server-permissions.json b/src/github-apps/data/ghes-3.7/server-to-server-permissions.json index 6d0002e39a..24b9b4857e 100644 --- a/src/github-apps/data/ghes-3.7/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.7/server-to-server-permissions.json @@ -872,6 +872,45 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [] + }, + { + "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": [] + }, + { + "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": [] + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1685,45 +1724,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [] - }, - { - "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": [] - }, - { - "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": [] - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json index 7bb2243e40..2df492190f 100644 --- a/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json @@ -755,6 +755,39 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [], + "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": [], + "access": "read" + }, + { + "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": [], + "access": "write" + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1514,39 +1547,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [], - "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": [], - "access": "read" - }, - { - "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": [], - "access": "write" - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.8/server-to-server-permissions.json b/src/github-apps/data/ghes-3.8/server-to-server-permissions.json index 9c9601ab9d..7800cbfe63 100644 --- a/src/github-apps/data/ghes-3.8/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.8/server-to-server-permissions.json @@ -911,6 +911,45 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [] + }, + { + "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": [] + }, + { + "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": [] + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1820,45 +1859,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [] - }, - { - "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": [] - }, - { - "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": [] - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json index bf3bd4cf00..a9e27c316f 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json @@ -835,6 +835,39 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [], + "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": [], + "access": "read" + }, + { + "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": [], + "access": "write" + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1594,39 +1627,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [], - "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": [], - "access": "read" - }, - { - "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": [], - "access": "write" - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json index 80639723f7..f15d54f3f7 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json @@ -1007,6 +1007,45 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Pre-receive hooks", + "displayTitle": "Organization permissions for \"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": [] + }, + { + "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": [] + }, + { + "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": [] + } + ] + }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -1916,45 +1955,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "organization pre receive hooks", - "displayTitle": "Organization pre receive hooks permissions", - "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": [] - }, - { - "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": [] - }, - { - "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": [] - } - ] - }, "actions": { "title": "Actions", "displayTitle": "Repository permissions for \"Actions\"", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index a266e992e1..26b76624f8 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "81e9e12dff09bb5cf8098d46f401a238cc73c851" + "sha": "45ba714d4fde4f522d5cad95427eea033423da8f" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 5842f2bd32..e5ae33ed16 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -153334,10 +153334,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -153477,10 +153477,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -154704,7 +154704,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -154725,7 +154725,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -155298,10 +155298,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -156515,7 +156515,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -156536,7 +156536,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -156977,10 +156977,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -158194,7 +158194,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -158215,7 +158215,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -159235,10 +159235,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -160452,7 +160452,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -160473,7 +160473,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -160915,10 +160915,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -162132,7 +162132,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -162153,7 +162153,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -162656,10 +162656,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -162799,10 +162799,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -162942,10 +162942,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -164169,7 +164169,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -164190,7 +164190,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -164773,10 +164773,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -165990,7 +165990,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -166011,7 +166011,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -166449,10 +166449,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -167666,7 +167666,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -167687,7 +167687,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -168173,10 +168173,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -169390,7 +169390,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -169411,7 +169411,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -169920,10 +169920,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -171137,7 +171137,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -171158,7 +171158,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -172450,10 +172450,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -178469,7 +178469,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -178490,7 +178490,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -178962,10 +178962,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -180179,7 +180179,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -180200,7 +180200,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -180698,10 +180698,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -181915,7 +181915,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -181936,7 +181936,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -182339,18 +182339,18 @@ "machines": [ { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, { "name": "premiumLinux", - "display_name": "8 cores, 16 GB RAM, 64 GB storage", + "display_name": "8 cores, 32 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, + "memory_in_bytes": 34359738368, "cpus": 8 } ] @@ -182383,7 +182383,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -182404,7 +182404,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -182515,18 +182515,18 @@ "machines": [ { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, { "name": "premiumLinux", - "display_name": "8 cores, 16 GB RAM, 64 GB storage", + "display_name": "8 cores, 32 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, + "memory_in_bytes": 34359738368, "cpus": 8 } ] @@ -182559,7 +182559,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -182580,7 +182580,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -184580,10 +184580,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -184723,10 +184723,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -184866,10 +184866,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -186093,7 +186093,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -186114,7 +186114,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -186887,10 +186887,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -187030,10 +187030,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -187173,10 +187173,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -188400,7 +188400,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -188421,7 +188421,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -189020,10 +189020,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -190237,7 +190237,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -190258,7 +190258,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -348578,8 +348578,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", @@ -349337,8 +349337,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index dda0729722..e0d83c12a3 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -258564,8 +258564,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", @@ -259311,8 +259311,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index c47d03a65b..34b4ce286a 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -165033,10 +165033,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -165176,10 +165176,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -166403,7 +166403,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -166424,7 +166424,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -166997,10 +166997,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -168214,7 +168214,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -168235,7 +168235,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -168676,10 +168676,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -169893,7 +169893,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -169914,7 +169914,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -170934,10 +170934,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -172151,7 +172151,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -172172,7 +172172,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -172614,10 +172614,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -173831,7 +173831,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -173852,7 +173852,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -174355,10 +174355,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -174498,10 +174498,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -174641,10 +174641,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -175868,7 +175868,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -175889,7 +175889,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -176472,10 +176472,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -177689,7 +177689,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -177710,7 +177710,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -178148,10 +178148,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -179365,7 +179365,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -179386,7 +179386,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -179872,10 +179872,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -181089,7 +181089,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -181110,7 +181110,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -181619,10 +181619,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -182836,7 +182836,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -182857,7 +182857,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -184149,10 +184149,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -190168,7 +190168,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -190189,7 +190189,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -190661,10 +190661,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -191878,7 +191878,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -191899,7 +191899,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -192397,10 +192397,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -193614,7 +193614,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -193635,7 +193635,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -194038,18 +194038,18 @@ "machines": [ { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, { "name": "premiumLinux", - "display_name": "8 cores, 16 GB RAM, 64 GB storage", + "display_name": "8 cores, 32 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, + "memory_in_bytes": 34359738368, "cpus": 8 } ] @@ -194082,7 +194082,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -194103,7 +194103,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -194214,18 +194214,18 @@ "machines": [ { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, { "name": "premiumLinux", - "display_name": "8 cores, 16 GB RAM, 64 GB storage", + "display_name": "8 cores, 32 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, + "memory_in_bytes": 34359738368, "cpus": 8 } ] @@ -194258,7 +194258,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -194279,7 +194279,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -196279,10 +196279,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -196422,10 +196422,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -196565,10 +196565,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -197792,7 +197792,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -197813,7 +197813,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -198586,10 +198586,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -198729,10 +198729,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -198872,10 +198872,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -200099,7 +200099,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -200120,7 +200120,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -200719,10 +200719,10 @@ }, "machine": { "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, + "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, @@ -201936,7 +201936,7 @@ "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" + "4 cores, 16 GB RAM, 64 GB storage" ] }, "operating_system": { @@ -201957,7 +201957,7 @@ "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ - 8589934592 + 17179869184 ] }, "cpus": { @@ -362133,8 +362133,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", @@ -362892,8 +362892,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 8fb0912566..f899d73768 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -332185,8 +332185,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", @@ -332922,8 +332922,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 1afc42617d..4dc76f3a20 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -326721,8 +326721,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", @@ -327458,8 +327458,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index dd3cd9633f..2dce4e4559 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -329584,8 +329584,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", @@ -330321,8 +330321,8 @@ "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": false, - "secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md" + "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", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 3c18e7d70d..b0c2afa51a 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -36,5 +36,5 @@ ] } }, - "sha": "81e9e12dff09bb5cf8098d46f401a238cc73c851" + "sha": "45ba714d4fde4f522d5cad95427eea033423da8f" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 1d2052f0db..aff46a8a77 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -24983,6 +24983,4911 @@ "category": "deployment_protection_rule" } }, + "deployment_review": { + "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "rejected" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requestor", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "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 objects", + "name": "reviewers", + "in": "body", + "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": "type", + "description": "", + "enum": [ + "User", + "Team" + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", @@ -66674,6 +71579,3171 @@ "category": "merge_group" } }, + "merge_queue_entry": { + "default": { + "descriptionHtml": "

A pull request was removed from a merge queue.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"Automatically merging a pull request.\"

\n

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

\n

Note: The pull request merge queue feature is currently in limited private beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_queue", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "merge_queue_entry", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_solo", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "message", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "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": "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": "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": "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": "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 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": "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": "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": "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": "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 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": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_queue_entry" + } + }, "meta": { "deleted": { "descriptionHtml": "

The webhook was deleted.

", @@ -165480,6 +173550,4195 @@ "category": "repository_import" } }, + "repository_ruleset": { + "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 permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository_ruleset", + "in": "body", + "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" + ] + }, + { + "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 only available with GitHub Enterprise).

", + "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", + "name": "actor_id", + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true + }, + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, + "enum": [ + "RepositoryRole", + "Team", + "Integration", + "OrganizationAdmin" + ] + }, + { + "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.

", + "isRequired": true, + "enum": [ + "always", + "pull_request" + ] + } + ] + }, + { + "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", + "name": "html", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "

The html URL of the ruleset

" + } + ] + } + ] + }, + { + "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": "", + "childParamsGroups": [ + { + "type": "object", + "name": "creation", + "description": "

Only allow users with bypass permission to create matching refs.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "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 permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository_ruleset", + "in": "body", + "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" + ] + }, + { + "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 only available with GitHub Enterprise).

", + "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", + "name": "actor_id", + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true + }, + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, + "enum": [ + "RepositoryRole", + "Team", + "Integration", + "OrganizationAdmin" + ] + }, + { + "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.

", + "isRequired": true, + "enum": [ + "always", + "pull_request" + ] + } + ] + }, + { + "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", + "name": "html", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "

The html URL of the ruleset

" + } + ] + } + ] + }, + { + "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": "", + "childParamsGroups": [ + { + "type": "object", + "name": "creation", + "description": "

Only allow users with bypass permission to create matching refs.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "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 permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository_ruleset", + "in": "body", + "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" + ] + }, + { + "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 only available with GitHub Enterprise).

", + "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", + "name": "actor_id", + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true + }, + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, + "enum": [ + "RepositoryRole", + "Team", + "Integration", + "OrganizationAdmin" + ] + }, + { + "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.

", + "isRequired": true, + "enum": [ + "always", + "pull_request" + ] + } + ] + }, + { + "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", + "name": "html", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "

The html URL of the ruleset

" + } + ] + } + ] + }, + { + "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": "", + "childParamsGroups": [ + { + "type": "object", + "name": "creation", + "description": "

Only allow users with bypass permission to create matching refs.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "repository_ruleset" + } + }, "repository_vulnerability_alert": { "create": { "descriptionHtml": "

A repository vulnerability alert was created.

", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index b058486bb8..da498ea5ba 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -24983,6 +24983,4911 @@ "category": "deployment_protection_rule" } }, + "deployment_review": { + "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "rejected" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requestor", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "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 objects", + "name": "reviewers", + "in": "body", + "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": "type", + "description": "", + "enum": [ + "User", + "Team" + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", @@ -64036,6 +68941,3171 @@ "category": "membership" } }, + "merge_queue_entry": { + "default": { + "descriptionHtml": "

A pull request was removed from a merge queue.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"Automatically merging a pull request.\"

\n

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

\n

Note: The pull request merge queue feature is currently in limited private beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_queue", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "merge_queue_entry", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_solo", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "message", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "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": "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": "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": "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": "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 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": "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": "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": "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": "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 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": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_queue_entry" + } + }, "meta": { "deleted": { "descriptionHtml": "

The webhook was deleted.

", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index b811b282fd..86f63a70f4 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -24983,6 +24983,4911 @@ "category": "deployment_protection_rule" } }, + "deployment_review": { + "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "rejected" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requestor", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "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 objects", + "name": "reviewers", + "in": "body", + "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": "type", + "description": "", + "enum": [ + "User", + "Team" + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", @@ -66674,6 +71579,3171 @@ "category": "merge_group" } }, + "merge_queue_entry": { + "default": { + "descriptionHtml": "

A pull request was removed from a merge queue.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"Automatically merging a pull request.\"

\n

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

\n

Note: The pull request merge queue feature is currently in limited private beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_queue", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "merge_queue_entry", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_solo", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "message", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "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": "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": "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": "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": "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 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": "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": "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": "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": "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 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": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_queue_entry" + } + }, "meta": { "deleted": { "descriptionHtml": "

The webhook was deleted.

", @@ -165480,6 +173550,4195 @@ "category": "repository_import" } }, + "repository_ruleset": { + "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 permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository_ruleset", + "in": "body", + "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" + ] + }, + { + "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.

", + "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", + "name": "actor_id", + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true + }, + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, + "enum": [ + "RepositoryRole", + "Team", + "Integration", + "OrganizationAdmin" + ] + }, + { + "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.

", + "isRequired": true, + "enum": [ + "always", + "pull_request" + ] + } + ] + }, + { + "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", + "name": "html", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "

The html URL of the ruleset

" + } + ] + } + ] + }, + { + "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": "", + "childParamsGroups": [ + { + "type": "object", + "name": "creation", + "description": "

Only allow users with bypass permission to create matching refs.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "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 permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository_ruleset", + "in": "body", + "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" + ] + }, + { + "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.

", + "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", + "name": "actor_id", + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true + }, + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, + "enum": [ + "RepositoryRole", + "Team", + "Integration", + "OrganizationAdmin" + ] + }, + { + "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.

", + "isRequired": true, + "enum": [ + "always", + "pull_request" + ] + } + ] + }, + { + "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", + "name": "html", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "

The html URL of the ruleset

" + } + ] + } + ] + }, + { + "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": "", + "childParamsGroups": [ + { + "type": "object", + "name": "creation", + "description": "

Only allow users with bypass permission to create matching refs.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "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 permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository_ruleset", + "in": "body", + "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" + ] + }, + { + "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.

", + "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", + "name": "actor_id", + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true + }, + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, + "enum": [ + "RepositoryRole", + "Team", + "Integration", + "OrganizationAdmin" + ] + }, + { + "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.

", + "isRequired": true, + "enum": [ + "always", + "pull_request" + ] + } + ] + }, + { + "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", + "name": "html", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "

The html URL of the ruleset

" + } + ] + } + ] + }, + { + "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": "", + "childParamsGroups": [ + { + "type": "object", + "name": "creation", + "description": "

Only allow users with bypass permission to create matching refs.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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 branches.

", + "isRequired": [ + "type" + ], + "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 branches can be merged into a branch that matches this rule.

", + "isRequired": [ + "type" + ], + "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 branches must have verified signatures.

", + "isRequired": [ + "type" + ], + "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.

", + "isRequired": [ + "type" + ], + "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": "object", + "name": "required_status_checks", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "required_status_checks" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "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 branches.

", + "isRequired": [ + "type" + ], + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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

", + "isRequired": [ + "type" + ], + "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 will appear to users.

" + }, + { + "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 + } + ] + } + ] + } + ], + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "repository_ruleset" + } + }, "repository_vulnerability_alert": { "create": { "descriptionHtml": "

A repository vulnerability alert was created.

", diff --git a/src/webhooks/data/ghes-3.10/schema.json b/src/webhooks/data/ghes-3.10/schema.json index 3871784c67..821abdaaf1 100644 --- a/src/webhooks/data/ghes-3.10/schema.json +++ b/src/webhooks/data/ghes-3.10/schema.json @@ -23897,6 +23897,4911 @@ "category": "deployment_protection_rule" } }, + "deployment_review": { + "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "rejected" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requestor", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "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 objects", + "name": "reviewers", + "in": "body", + "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": "type", + "description": "", + "enum": [ + "User", + "Team" + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", @@ -64248,6 +69153,3171 @@ "category": "membership" } }, + "merge_queue_entry": { + "default": { + "descriptionHtml": "

A pull request was removed from a merge queue.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"Automatically merging a pull request.\"

\n

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

\n

Note: The pull request merge queue feature is currently in limited private beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_queue", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "merge_queue_entry", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_solo", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "message", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "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": "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": "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": "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": "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 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": "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": "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": "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": "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 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": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_queue_entry" + } + }, "meta": { "deleted": { "descriptionHtml": "

The webhook was deleted.

", diff --git a/src/webhooks/data/ghes-3.7/schema.json b/src/webhooks/data/ghes-3.7/schema.json index c60bb69c9d..f32124f200 100644 --- a/src/webhooks/data/ghes-3.7/schema.json +++ b/src/webhooks/data/ghes-3.7/schema.json @@ -19859,6 +19859,4911 @@ "category": "deployment" } }, + "deployment_review": { + "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "rejected" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requestor", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "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 objects", + "name": "reviewers", + "in": "body", + "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": "type", + "description": "", + "enum": [ + "User", + "Team" + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", @@ -59022,6 +63927,3171 @@ "category": "membership" } }, + "merge_queue_entry": { + "default": { + "descriptionHtml": "

A pull request was removed from a merge queue.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"Automatically merging a pull request.\"

\n

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

\n

Note: The pull request merge queue feature is currently in limited private beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_queue", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "merge_queue_entry", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_solo", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "message", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "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": "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": "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": "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": "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 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": "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": "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": "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": "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 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": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_queue_entry" + } + }, "meta": { "deleted": { "descriptionHtml": "

The webhook was deleted.

", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index 5eba94e8bd..c894cdf756 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -19859,6 +19859,4911 @@ "category": "deployment" } }, + "deployment_review": { + "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "rejected" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requestor", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "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 objects", + "name": "reviewers", + "in": "body", + "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": "type", + "description": "", + "enum": [ + "User", + "Team" + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", @@ -59022,6 +63927,3171 @@ "category": "membership" } }, + "merge_queue_entry": { + "default": { + "descriptionHtml": "

A pull request was removed from a merge queue.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"Automatically merging a pull request.\"

\n

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

\n

Note: The pull request merge queue feature is currently in limited private beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_queue", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "merge_queue_entry", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_solo", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "message", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "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": "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": "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": "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": "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 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": "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": "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": "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": "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 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": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_queue_entry" + } + }, "meta": { "deleted": { "descriptionHtml": "

The webhook was deleted.

", diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json index 10e1db00ce..e82106fc8f 100644 --- a/src/webhooks/data/ghes-3.9/schema.json +++ b/src/webhooks/data/ghes-3.9/schema.json @@ -20079,6 +20079,4911 @@ "category": "deployment" } }, + "deployment_review": { + "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "rejected" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "approver", + "in": "body", + "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": "comment", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "reviewers", + "in": "body", + "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", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requestor", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "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 objects", + "name": "reviewers", + "in": "body", + "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": "type", + "description": "", + "enum": [ + "User", + "Team" + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "since", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "workflow_job_run", + "in": "body", + "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", + "in": "body", + "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": "" + }, + { + "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": "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": "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": "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" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", @@ -60392,6 +65297,3171 @@ "category": "membership" } }, + "merge_queue_entry": { + "default": { + "descriptionHtml": "

A pull request was removed from a merge queue.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"Automatically merging a pull request.\"

\n

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

\n

Note: The pull request merge queue feature is currently in limited private beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_queue", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "merge_queue_entry", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_solo", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "message", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "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": "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": "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": "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": "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 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": "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": "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": "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": "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 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": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_queue_entry" + } + }, "meta": { "deleted": { "descriptionHtml": "

The webhook was deleted.

", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index b84f212e24..acefeb2865 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "81e9e12dff09bb5cf8098d46f401a238cc73c851" + "sha": "45ba714d4fde4f522d5cad95427eea033423da8f" } \ No newline at end of file