feat: schema updates (#576)

- feat: new `keys` permission for apps - feat: new `run_attempt`, `run_started_at` and `previous_attempt_url` properties for `workflow_run` - feat: new `topics` property for `repository` - feat: new `run_attempt` property on `workflow_job` - feat: new `allow_update_branch` property on `Repository` - feat: new `draft` property on `issue` object - feat: `visibility` is a required field on `repository` - fix: repository is not always present for `project_card` events - fix: add `internal` to allowed values for `repository#visibility` - fix: the property `check_suite#after` can be `null` - fix: add missing `branch_protection_rule` event to `App` - fix: correct typo in `enum` for `App` key `permission`
octokit · Nov 22, 2021 · d99b9a7 · d99b9a7
1 parent d68e3b2
commit d99b9a7
Show file tree

Hide file tree

Showing 236 changed files with 2,001 additions and 684 deletions.
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
@@ -119,7 +119,9 @@
     "open_issues": 39,
     "watchers": 0,
     "default_branch": "main",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -119,7 +119,9 @@
     "open_issues": 39,
     "watchers": 0,
     "default_branch": "main",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -123,7 +123,9 @@
     "open_issues": 39,
     "watchers": 0,
     "default_branch": "main",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -276,7 +276,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -281,7 +281,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -281,7 +281,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -294,7 +294,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -281,7 +281,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -268,7 +268,9 @@
     "open_issues": 1504,
     "watchers": 87864,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -185,7 +185,9 @@
     "open_issues": 3,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -185,7 +185,9 @@
     "open_issues": 3,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -173,7 +173,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "main",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -199,7 +199,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -199,7 +199,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -175,7 +175,9 @@
     "open_issues": 1,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -175,7 +175,9 @@
     "open_issues": 1,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -199,7 +199,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -199,7 +199,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -162,7 +162,9 @@
     "open_issues": 10,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -139,7 +139,9 @@
     "open_issues": 11,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -156,7 +156,9 @@
     "open_issues": 11,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -119,7 +119,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -119,7 +119,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -127,7 +127,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -127,7 +127,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -127,7 +127,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -127,7 +127,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/content_reference/created.payload.json b/payload-examples/api.github.com/content_reference/created.payload.json
@@ -97,7 +97,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "sender": {
     "login": "Codertocat",

diff --git a/payload-examples/api.github.com/create/payload.json b/payload-examples/api.github.com/create/payload.json
@@ -97,7 +97,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -97,7 +97,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -97,7 +97,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -97,7 +97,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/delete/payload.json b/payload-examples/api.github.com/delete/payload.json
@@ -95,7 +95,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -95,7 +95,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "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
@@ -95,7 +95,9 @@
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "organization": {
     "login": "Octocoders",

diff --git a/payload-examples/api.github.com/deploy_key/created.payload.json b/payload-examples/api.github.com/deploy_key/created.payload.json
@@ -101,7 +101,9 @@
     "open_issues": 1,
     "watchers": 0,
     "default_branch": "master",
-    "is_template": false
+    "is_template": false,
+    "topics": [],
+    "visibility": "public"
   },
   "sender": {
     "login": "Codertocat",