feat: ClosedEvent#commit is deprecated, use ClosedEvent#closer (#14)

octokit · Jan 10, 2018 · a9f6d3c · a9f6d3c
1 parent 07b8022
commit a9f6d3c
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 13 deletions.
diff --git a/schema.graphql b/schema.graphql
@@ -408,14 +408,20 @@ type ClosedEvent implements Node {
   # Object that was closed.
   closable: Closable!
 
+  # Object which triggered the creation of this event.
+  closer: Closer
+
   # Identifies the commit associated with the 'closed' event.
-  commit: Commit
+  commit: Commit @deprecated(reason: "Use ClosedEvent.closer instead.")
 
   # Identifies the date and time when the object was created.
   createdAt: DateTime!
   id: ID!
 }
 
+# The object which triggered a `ClosedEvent`.
+union Closer = Commit | PullRequest
+
 # The Code of Conduct for a repository
 type CodeOfConduct {
   # The body of the CoC

diff --git a/schema.json b/schema.json
@@ -22933,6 +22933,16 @@
         "enumValues": null,
         "possibleTypes": null
       },
+      {
+        "kind": "SCALAR",
+        "name": "Date",
+        "description": "An ISO-8601 encoded date string.",
+        "fields": null,
+        "inputFields": null,
+        "interfaces": null,
+        "enumValues": null,
+        "possibleTypes": null
+      },
       {
         "kind": "SCALAR",
         "name": "X509Certificate",
@@ -25508,6 +25518,18 @@
             "isDeprecated": false,
             "deprecationReason": null
           },
+          {
+            "name": "closer",
+            "description": "Object which triggered the creation of this event.",
+            "args": [],
+            "type": {
+              "kind": "UNION",
+              "name": "Closer",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "commit",
             "description": "Identifies the commit associated with the 'closed' event.",
@@ -25517,8 +25539,8 @@
               "name": "Commit",
               "ofType": null
             },
-            "isDeprecated": false,
-            "deprecationReason": null
+            "isDeprecated": true,
+            "deprecationReason": "Use ClosedEvent.closer instead."
           },
           {
             "name": "createdAt",
@@ -25564,6 +25586,27 @@
         "enumValues": null,
         "possibleTypes": null
       },
+      {
+        "kind": "UNION",
+        "name": "Closer",
+        "description": "The object which triggered a `ClosedEvent`.",
+        "fields": null,
+        "inputFields": null,
+        "interfaces": null,
+        "enumValues": null,
+        "possibleTypes": [
+          {
+            "kind": "OBJECT",
+            "name": "Commit",
+            "ofType": null
+          },
+          {
+            "kind": "OBJECT",
+            "name": "PullRequest",
+            "ofType": null
+          }
+        ]
+      },
       {
         "kind": "OBJECT",
         "name": "ReopenedEvent",
@@ -34014,16 +34057,6 @@
         ],
         "possibleTypes": null
       },
-      {
-        "kind": "SCALAR",
-        "name": "Date",
-        "description": "An ISO-8601 encoded date string.",
-        "fields": null,
-        "inputFields": null,
-        "interfaces": null,
-        "enumValues": null,
-        "possibleTypes": null
-      },
       {
         "kind": "OBJECT",
         "name": "MarketplaceListingConnection",