fix: update the webhook payloads with updated property information (#454

) * fix: `SecurityAdvisoryEvent#security_advisory.cwes.vector_string` can be `null` * fix: `PullRequestReviewCommentEditedEvent` can have en empty `changes` property * fix: add `auto_merge` property to `SimplePullRequest` * fix: add missing `auto_merge` property to other `PullRequestReviewCommentEvent` actions * fix: `PullRequestReviewCommentEvent#comment.line` can be `null` * fix: add properties as required in `PullRequestReviewCommentEvent` * fix: `WorkflowRun#check_suite_node_id` is a `string` * fix: `CheckRunCreatedEvent#check_run.check_suite.conclusion` can also be a `string` * build: generate types & index.json
octokit · Apr 22, 2021 · 1b72978 · 1b72978
1 parent 508e749
commit 1b72978
Show file tree

Hide file tree

Showing 21 changed files with 148 additions and 48 deletions.
diff --git a/payload-examples/api.github.com/pull_request_review/dismissed.payload.json b/payload-examples/api.github.com/pull_request_review/dismissed.payload.json
@@ -404,6 +404,7 @@
       }
     },
     "author_association": "OWNER",
+    "auto_merge": null,
     "active_lock_reason": null
   },
   "repository": {

diff --git a/payload-examples/api.github.com/pull_request_review/submitted.payload.json b/payload-examples/api.github.com/pull_request_review/submitted.payload.json
@@ -404,6 +404,7 @@
       }
     },
     "author_association": "OWNER",
+    "auto_merge": null,
     "active_lock_reason": null
   },
   "repository": {

diff --git a/payload-examples/api.github.com/pull_request_review/submitted.with-organization.payload.json b/payload-examples/api.github.com/pull_request_review/submitted.with-organization.payload.json
@@ -404,6 +404,7 @@
       }
     },
     "author_association": "OWNER",
+    "auto_merge": null,
     "active_lock_reason": null
   },
   "repository": {

diff --git a/payload-examples/api.github.com/pull_request_review_comment/created.payload.json b/payload-examples/api.github.com/pull_request_review_comment/created.payload.json
@@ -47,7 +47,13 @@
       "pull_request": {
         "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
       }
-    }
+    },
+    "start_line": null,
+    "original_start_line": null,
+    "start_side": null,
+    "line": 265,
+    "original_line": 265,
+    "side": "RIGHT"
   },
   "pull_request": {
     "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",

diff --git a/...xamples/api.github.com/pull_request_review_comment/created.with-organization.payload.json b/...xamples/api.github.com/pull_request_review_comment/created.with-organization.payload.json
@@ -47,7 +47,13 @@
       "pull_request": {
         "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
       }
-    }
+    },
+    "start_line": null,
+    "original_start_line": null,
+    "start_side": null,
+    "line": 265,
+    "original_line": 265,
+    "side": "RIGHT"
   },
   "pull_request": {
     "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",

diff --git a/payload-examples/api.github.com/pull_request_review_comment/deleted.payload.json b/payload-examples/api.github.com/pull_request_review_comment/deleted.payload.json
@@ -47,7 +47,13 @@
       "pull_request": {
         "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
       }
-    }
+    },
+    "start_line": null,
+    "original_start_line": null,
+    "start_side": null,
+    "line": 265,
+    "original_line": 265,
+    "side": "RIGHT"
   },
   "pull_request": {
     "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",

diff --git a/payload-examples/api.github.com/pull_request_review_comment/edited.payload.json b/payload-examples/api.github.com/pull_request_review_comment/edited.payload.json
@@ -48,7 +48,13 @@
       "pull_request": {
         "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
       }
-    }
+    },
+    "start_line": null,
+    "original_start_line": null,
+    "start_side": null,
+    "line": 265,
+    "original_line": 265,
+    "side": "RIGHT"
   },
   "pull_request": {
     "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",

diff --git a/payload-examples/api.github.com/workflow_run/completed.payload.json b/payload-examples/api.github.com/workflow_run/completed.payload.json
@@ -152,7 +152,7 @@
     "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/289782451/cancel",
     "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/1291536064",
     "check_suite_id": 1291536064,
-    "check_suite_node_id": 1291536064,
+    "check_suite_node_id": "MDg6V29ya2Zsb3cyODIzNTI1",
     "conclusion": "success",
     "created_at": "2020-10-05T16:33:24Z",
     "event": "repository_dispatch",

diff --git a/payload-examples/api.github.com/workflow_run/requested.payload.json b/payload-examples/api.github.com/workflow_run/requested.payload.json
@@ -152,7 +152,7 @@
     "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/289782451/cancel",
     "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/1291536064",
     "check_suite_id": 1291536064,
-    "check_suite_node_id": 1291536064,
+    "check_suite_node_id": "MDg6V29ya2Zsb3cyODIzNTI1",
     "conclusion": null,
     "created_at": "2020-10-05T16:33:24Z",
     "event": "repository_dispatch",

diff --git a/payload-examples/index.json b/payload-examples/index.json
@@ -45138,6 +45138,7 @@
             }
           },
           "author_association": "OWNER",
+          "auto_merge": null,
           "active_lock_reason": null
         },
         "repository": {
@@ -45681,6 +45682,7 @@
             }
           },
           "author_association": "OWNER",
+          "auto_merge": null,
           "active_lock_reason": null
         },
         "repository": {
@@ -46210,6 +46212,7 @@
             }
           },
           "author_association": "OWNER",
+          "auto_merge": null,
           "active_lock_reason": null
         },
         "repository": {
@@ -46924,7 +46927,13 @@
             "pull_request": {
               "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
             }
-          }
+          },
+          "start_line": null,
+          "original_start_line": null,
+          "start_side": null,
+          "line": 265,
+          "original_line": 265,
+          "side": "RIGHT"
         },
         "pull_request": {
           "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
@@ -47461,7 +47470,13 @@
             "pull_request": {
               "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
             }
-          }
+          },
+          "start_line": null,
+          "original_start_line": null,
+          "start_side": null,
+          "line": 265,
+          "original_line": 265,
+          "side": "RIGHT"
         },
         "pull_request": {
           "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
@@ -48012,7 +48027,13 @@
             "pull_request": {
               "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
             }
-          }
+          },
+          "start_line": null,
+          "original_start_line": null,
+          "start_side": null,
+          "line": 265,
+          "original_line": 265,
+          "side": "RIGHT"
         },
         "pull_request": {
           "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
@@ -48554,7 +48575,13 @@
             "pull_request": {
               "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
             }
-          }
+          },
+          "start_line": null,
+          "original_start_line": null,
+          "start_side": null,
+          "line": 265,
+          "original_line": 265,
+          "side": "RIGHT"
         },
         "pull_request": {
           "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
@@ -57982,7 +58009,7 @@
           "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/289782451/cancel",
           "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/1291536064",
           "check_suite_id": 1291536064,
-          "check_suite_node_id": 1291536064,
+          "check_suite_node_id": "MDg6V29ya2Zsb3cyODIzNTI1",
           "conclusion": "success",
           "created_at": "2020-10-05T16:33:24Z",
           "event": "repository_dispatch",
@@ -58305,7 +58332,7 @@
           "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/289782451/cancel",
           "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/1291536064",
           "check_suite_id": 1291536064,
-          "check_suite_node_id": 1291536064,
+          "check_suite_node_id": "MDg6V29ya2Zsb3cyODIzNTI1",
           "conclusion": null,
           "created_at": "2020-10-05T16:33:24Z",
           "event": "repository_dispatch",

diff --git a/payload-schemas/schemas/check_run/created.schema.json b/payload-schemas/schemas/check_run/created.schema.json
@@ -115,7 +115,19 @@
               "type": "string",
               "enum": ["queued", "in_progress", "completed"]
             },
-            "conclusion": { "type": "null" },
+            "conclusion": {
+              "type": ["string", "null"],
+              "enum": [
+                "success",
+                "failure",
+                "neutral",
+                "cancelled",
+                "timed_out",
+                "action_required",
+                "stale",
+                null
+              ]
+            },
             "url": { "type": "string", "format": "uri" },
             "before": { "type": ["string", "null"] },
             "after": { "type": ["string", "null"] },

diff --git a/payload-schemas/schemas/common/simple-pull-request.schema.json b/payload-schemas/schemas/common/simple-pull-request.schema.json
@@ -36,6 +36,7 @@
     "base",
     "_links",
     "author_association",
+    "auto_merge",
     "active_lock_reason"
   ],
   "type": "object",
@@ -134,6 +135,7 @@
       "additionalProperties": false
     },
     "author_association": { "$ref": "author_association.schema.json" },
+    "auto_merge": { "type": "null" },
     "active_lock_reason": {
       "type": ["string", "null"],
       "enum": ["resolved", "off-topic", "too heated", "spam", null]

diff --git a/payload-schemas/schemas/common/workflow-run.schema.json b/payload-schemas/schemas/common/workflow-run.schema.json
@@ -36,7 +36,7 @@
     "cancel_url": { "type": "string", "format": "uri" },
     "check_suite_url": { "type": "string", "format": "uri" },
     "check_suite_id": { "type": "integer" },
-    "check_suite_node_id": { "type": "integer" },
+    "check_suite_node_id": { "type": "string" },
     "conclusion": { "type": ["string", "null"] },
     "created_at": { "type": "string", "format": "date-time" },
     "event": { "type": "string" },

diff --git a/payload-schemas/schemas/pull_request_review/edited.schema.json b/payload-schemas/schemas/pull_request_review/edited.schema.json
@@ -14,7 +14,6 @@
     "action": { "type": "string", "enum": ["edited"] },
     "changes": {
       "type": "object",
-      "required": ["body"],
       "properties": {
         "body": {
           "type": "object",

diff --git a/payload-schemas/schemas/pull_request_review_comment/created.schema.json b/payload-schemas/schemas/pull_request_review_comment/created.schema.json
@@ -26,7 +26,13 @@
         "html_url",
         "pull_request_url",
         "author_association",
-        "_links"
+        "_links",
+        "start_line",
+        "original_start_line",
+        "original_line",
+        "line",
+        "start_side",
+        "side"
       ],
       "properties": {
         "url": {
@@ -112,7 +118,7 @@
           "description": "The side of the first line of the range for a multi-line comment."
         },
         "line": {
-          "type": "integer",
+          "type": ["integer", "null"],
           "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment"
         },
         "original_line": {
@@ -271,6 +277,7 @@
           },
           "additionalProperties": false
         },
+        "auto_merge": { "type": "null" },
         "author_association": {
           "$ref": "common/author_association.schema.json"
         }

diff --git a/payload-schemas/schemas/pull_request_review_comment/deleted.schema.json b/payload-schemas/schemas/pull_request_review_comment/deleted.schema.json
@@ -26,7 +26,13 @@
         "html_url",
         "pull_request_url",
         "author_association",
-        "_links"
+        "_links",
+        "start_line",
+        "original_start_line",
+        "original_line",
+        "line",
+        "start_side",
+        "side"
       ],
       "properties": {
         "url": {
@@ -112,7 +118,7 @@
           "description": "The side of the first line of the range for a multi-line comment."
         },
         "line": {
-          "type": "integer",
+          "type": ["integer", "null"],
           "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment"
         },
         "original_line": {
@@ -271,6 +277,7 @@
           },
           "additionalProperties": false
         },
+        "auto_merge": { "type": "null" },
         "author_association": {
           "$ref": "common/author_association.schema.json"
         }

diff --git a/payload-schemas/schemas/pull_request_review_comment/edited.schema.json b/payload-schemas/schemas/pull_request_review_comment/edited.schema.json
@@ -51,7 +51,13 @@
         "html_url",
         "pull_request_url",
         "author_association",
-        "_links"
+        "_links",
+        "start_line",
+        "original_start_line",
+        "original_line",
+        "line",
+        "start_side",
+        "side"
       ],
       "properties": {
         "url": {
@@ -137,7 +143,7 @@
           "description": "The side of the first line of the range for a multi-line comment."
         },
         "line": {
-          "type": "integer",
+          "type": ["integer", "null"],
           "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment"
         },
         "original_line": {
@@ -296,6 +302,7 @@
           },
           "additionalProperties": false
         },
+        "auto_merge": { "type": "null" },
         "author_association": {
           "$ref": "common/author_association.schema.json"
         }

diff --git a/payload-schemas/schemas/security_advisory/performed.schema.json b/payload-schemas/schemas/security_advisory/performed.schema.json
@@ -27,7 +27,7 @@
           "type": "object",
           "required": ["vector_string", "score"],
           "properties": {
-            "vector_string": { "type": "string" },
+            "vector_string": { "type": ["string", "null"] },
             "score": { "type": "number" }
           },
           "additionalProperties": false

diff --git a/payload-schemas/schemas/security_advisory/published.schema.json b/payload-schemas/schemas/security_advisory/published.schema.json
@@ -27,7 +27,7 @@
           "type": "object",
           "required": ["vector_string", "score"],
           "properties": {
-            "vector_string": { "type": "string" },
+            "vector_string": { "type": ["string", "null"] },
             "score": { "type": "number" }
           },
           "additionalProperties": false

diff --git a/payload-schemas/schemas/security_advisory/updated.schema.json b/payload-schemas/schemas/security_advisory/updated.schema.json
@@ -27,7 +27,7 @@
           "type": "object",
           "required": ["vector_string", "score"],
           "properties": {
-            "vector_string": { "type": "string" },
+            "vector_string": { "type": ["string", "null"] },
             "score": { "type": "number" }
           },
           "additionalProperties": false