feat: schema updates (adds custom_properties field) to branch_protect…

…ion_rule, check_suite, code_scanning_alert, commit_comment, create, delete, dependabot_alert, deploy_key, deployment, deployment_review, deployment_status, discussion, disscussion_comment, fork, gollum, issue_comment, issues, label, member, merge_group, meta, milestone, package, page_build. ping, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, pull_request_review_thread, push, registry_package, release, repository, repository_dispatch, repository_import, repository_vulnerability_alert, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_job, workflow_run, branch_protection_configuration, common, custom_property, custom_property_values (#904) * feat: new `branch_protection_rule` event * feat: new `custom_property_values` event * feat: new `custom_property` on `repository` * fix: update examples * build: update types * fix: update examples * build: update types * build: update index.json --------- Co-authored-by: Nick Floyd <[email protected]>
octokit · Mar 11, 2024 · bc5f6fd · bc5f6fd
1 parent cdd43ea
commit bc5f6fd
Show file tree

Hide file tree

Showing 245 changed files with 1,604 additions and 686 deletions.
diff --git a/payload-examples/api.github.com/branch_protection_rule/created.1.payload.json b/payload-examples/api.github.com/branch_protection_rule/created.1.payload.json
@@ -132,7 +132,8 @@
     "forks": 0,
     "open_issues": 1,
     "watchers": 0,
-    "default_branch": "main"
+    "default_branch": "main",
+    "custom_properties": {}
   },
   "sender": {
     "login": "wolfy1339",

diff --git a/payload-examples/api.github.com/branch_protection_rule/created.payload.json b/payload-examples/api.github.com/branch_protection_rule/created.payload.json
@@ -122,7 +122,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "octo-org",

diff --git a/payload-examples/api.github.com/branch_protection_rule/deleted.payload.json b/payload-examples/api.github.com/branch_protection_rule/deleted.payload.json
@@ -122,7 +122,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "octo-org",

diff --git a/payload-examples/api.github.com/branch_protection_rule/edited.payload.json b/payload-examples/api.github.com/branch_protection_rule/edited.payload.json
@@ -139,7 +139,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "octo-org",

diff --git a/payload-examples/api.github.com/check_run/completed.1.payload.json b/payload-examples/api.github.com/check_run/completed.1.payload.json
@@ -279,7 +279,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/check_run/completed.payload.json b/payload-examples/api.github.com/check_run/completed.payload.json
@@ -284,7 +284,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/check_run/completed.with-organization.payload.json b/payload-examples/api.github.com/check_run/completed.with-organization.payload.json
@@ -284,7 +284,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/check_run/created.payload.json b/payload-examples/api.github.com/check_run/created.payload.json
@@ -297,7 +297,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/check_run/created.with-organization.payload.json b/payload-examples/api.github.com/check_run/created.with-organization.payload.json
@@ -284,7 +284,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/check_run/requested_action.payload.json b/payload-examples/api.github.com/check_run/requested_action.payload.json
@@ -271,7 +271,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "electron",

diff --git a/payload-examples/api.github.com/check_run/rerequested.payload.json b/payload-examples/api.github.com/check_run/rerequested.payload.json
@@ -188,7 +188,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "github",

diff --git a/payload-examples/api.github.com/check_run/rerequested.with-organization.payload.json b/payload-examples/api.github.com/check_run/rerequested.with-organization.payload.json
@@ -188,7 +188,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/check_suite/completed.1.payload.json b/payload-examples/api.github.com/check_suite/completed.1.payload.json
@@ -176,7 +176,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/check_suite/completed.payload.json b/payload-examples/api.github.com/check_suite/completed.payload.json
@@ -202,7 +202,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/check_suite/completed.with-organization.payload.json b/payload-examples/api.github.com/check_suite/completed.with-organization.payload.json
@@ -202,7 +202,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/check_suite/requested.payload.json b/payload-examples/api.github.com/check_suite/requested.payload.json
@@ -178,7 +178,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/...ples/api.github.com/check_suite/requested.payload.with-email-with-special-characters.json b/...ples/api.github.com/check_suite/requested.payload.with-email-with-special-characters.json
@@ -180,7 +180,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/check_suite/requested.with-organization.payload.json b/payload-examples/api.github.com/check_suite/requested.with-organization.payload.json
@@ -178,7 +178,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/check_suite/rerequested.payload.json b/payload-examples/api.github.com/check_suite/rerequested.payload.json
@@ -202,7 +202,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "octocoders-linter[bot]",

diff --git a/payload-examples/api.github.com/check_suite/rerequested.with-organization.payload.json b/payload-examples/api.github.com/check_suite/rerequested.with-organization.payload.json
@@ -202,7 +202,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/code_scanning_alert/closed-by-user.payload.json b/payload-examples/api.github.com/code_scanning_alert/closed-by-user.payload.json
@@ -165,7 +165,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/code_scanning_alert/created.payload.json b/payload-examples/api.github.com/code_scanning_alert/created.payload.json
@@ -142,7 +142,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/code_scanning_alert/fixed.payload.json b/payload-examples/api.github.com/code_scanning_alert/fixed.payload.json
@@ -159,7 +159,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/code_scanning_alert/reopened.payload.json b/payload-examples/api.github.com/code_scanning_alert/reopened.payload.json
@@ -122,7 +122,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/code_scanning_alert/reopened.with-organization.payload.json b/payload-examples/api.github.com/code_scanning_alert/reopened.with-organization.payload.json
@@ -122,7 +122,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/commit_comment/created.on-file.payload.json b/payload-examples/api.github.com/commit_comment/created.on-file.payload.json
@@ -130,7 +130,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/commit_comment/created.payload.json b/payload-examples/api.github.com/commit_comment/created.payload.json
@@ -130,7 +130,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/commit_comment/created.with-installation.payload.json b/payload-examples/api.github.com/commit_comment/created.with-installation.payload.json
@@ -130,7 +130,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/commit_comment/created.with-organization.payload.json b/payload-examples/api.github.com/commit_comment/created.with-organization.payload.json
@@ -130,7 +130,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/create/payload.json b/payload-examples/api.github.com/create/payload.json
@@ -100,7 +100,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/create/with-description.payload.json b/payload-examples/api.github.com/create/with-description.payload.json
@@ -100,7 +100,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/create/with-installation.payload.json b/payload-examples/api.github.com/create/with-installation.payload.json
@@ -100,7 +100,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/create/with-organization.payload.json b/payload-examples/api.github.com/create/with-organization.payload.json
@@ -100,7 +100,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/delete/payload.json b/payload-examples/api.github.com/delete/payload.json
@@ -98,7 +98,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/delete/with-installation.payload.json b/payload-examples/api.github.com/delete/with-installation.payload.json
@@ -98,7 +98,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/delete/with-organization.payload.json b/payload-examples/api.github.com/delete/with-organization.payload.json
@@ -98,7 +98,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/dependabot_alert/created.payload.json b/payload-examples/api.github.com/dependabot_alert/created.payload.json
@@ -179,7 +179,8 @@
     "forks": 0,
     "open_issues": 13,
     "watchers": 0,
-    "default_branch": "master"
+    "default_branch": "master",
+    "custom_properties": {}
   },
   "sender": {
     "login": "github",

diff --git a/payload-examples/api.github.com/dependabot_alert/fixed.payload.json b/payload-examples/api.github.com/dependabot_alert/fixed.payload.json
@@ -170,7 +170,8 @@
     "forks": 0,
     "open_issues": 0,
     "watchers": 0,
-    "default_branch": "main"
+    "default_branch": "main",
+    "custom_properties": {}
   },
   "sender": {
     "login": "github",

diff --git a/payload-examples/api.github.com/deploy_key/created.payload.json b/payload-examples/api.github.com/deploy_key/created.payload.json
@@ -104,7 +104,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/deployment/gh-pages.payload.json b/payload-examples/api.github.com/deployment/gh-pages.payload.json
@@ -208,7 +208,8 @@
     "is_template": false,
     "topics": [],
     "visibility": "public",
-    "web_commit_signoff_required": false
+    "web_commit_signoff_required": false,
+    "custom_properties": {}
   },
   "organization": {
     "login": "Octocoders",