fix: add missing properties to pull_request_review.submitted (#305)

* fix: add missing properties to pull_request_review.submitted * fix: adjust payload examples to validate * build: generate types
octokit · Jan 18, 2021 · 88bf8d5 · 88bf8d5
1 parent 7bd5ff0
commit 88bf8d5
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 5 deletions.
diff --git a/index.json b/index.json
@@ -38017,6 +38017,7 @@
             }
           ],
           "milestone": null,
+          "draft": false,
           "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits",
           "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments",
           "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}",
@@ -38286,7 +38287,8 @@
               "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
             }
           },
-          "author_association": "OWNER"
+          "author_association": "OWNER",
+          "active_lock_reason": null
         },
         "repository": {
           "id": 186853002,
@@ -38543,6 +38545,7 @@
             }
           ],
           "milestone": null,
+          "draft": false,
           "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits",
           "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments",
           "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}",
@@ -38812,7 +38815,8 @@
               "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
             }
           },
-          "author_association": "OWNER"
+          "author_association": "OWNER",
+          "active_lock_reason": null
         },
         "repository": {
           "id": 186853002,

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
@@ -134,6 +134,7 @@
       }
     ],
     "milestone": null,
+    "draft": false,
     "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits",
     "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments",
     "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}",
@@ -401,7 +402,8 @@
         "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
       }
     },
-    "author_association": "OWNER"
+    "author_association": "OWNER",
+    "active_lock_reason": null
   },
   "repository": {
     "id": 186853002,

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
@@ -134,6 +134,7 @@
       }
     ],
     "milestone": null,
+    "draft": false,
     "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits",
     "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments",
     "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}",
@@ -401,7 +402,8 @@
         "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
       }
     },
-    "author_association": "OWNER"
+    "author_association": "OWNER",
+    "active_lock_reason": null
   },
   "repository": {
     "id": 186853002,

diff --git a/payload-schemas/schemas/pull_request_review/submitted.schema.json b/payload-schemas/schemas/pull_request_review/submitted.schema.json
@@ -92,6 +92,7 @@
         "requested_teams",
         "labels",
         "milestone",
+        "draft",
         "commits_url",
         "review_comments_url",
         "review_comment_url",
@@ -100,7 +101,8 @@
         "head",
         "base",
         "_links",
-        "author_association"
+        "author_association",
+        "active_lock_reason"
       ],
       "properties": {
         "url": { "type": "string" },
@@ -197,6 +199,7 @@
           },
           "additionalProperties": false
         },
+        "draft": { "type": "boolean" },
         "commits_url": { "type": "string" },
         "review_comments_url": { "type": "string" },
         "review_comment_url": { "type": "string" },
@@ -388,6 +391,10 @@
             "NONE",
             "OWNER"
           ]
+        },
+        "active_lock_reason": {
+          "type": ["string", "null"],
+          "enum": ["resolved", "off-topic", "too heated", "spam", null]
         }
       },
       "additionalProperties": false

diff --git a/schema.d.ts b/schema.d.ts
@@ -7650,6 +7650,7 @@ export interface PullRequestReviewSubmittedEvent {
       due_on: string;
       closed_at: string | null;
     } | null;
+    draft: boolean;
     commits_url: string;
     review_comments_url: string;
     review_comment_url: string;
@@ -7742,6 +7743,7 @@ export interface PullRequestReviewSubmittedEvent {
       | "MEMBER"
       | "NONE"
       | "OWNER";
+    active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
   };
   repository: Repository;
   installation?: Installation;