fix: type of requester property on InstallationEvent & `Installat…

…ionRepositoriesEvent` should be `User` and not `null` (#428) Fixes #427
octokit · Apr 1, 2021 · 08a1a17 · 08a1a17
1 parent 4d94d0b
commit 08a1a17
Show file tree

Hide file tree

Showing 5 changed files with 204 additions and 2 deletions.
diff --git a/index.json b/index.json
@@ -13329,6 +13329,106 @@
           "site_admin": false
         }
       },
+      {
+        "action": "created",
+        "installation": {
+          "id": 957387,
+          "account": {
+            "login": "Codertocat",
+            "id": 21031067,
+            "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+            "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/Codertocat",
+            "html_url": "https://github.com/Codertocat",
+            "followers_url": "https://api.github.com/users/Codertocat/followers",
+            "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+            "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+            "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+            "repos_url": "https://api.github.com/users/Codertocat/repos",
+            "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+            "type": "User",
+            "site_admin": false
+          },
+          "repository_selection": "selected",
+          "access_tokens_url": "https://api.github.com/app/installations/957387/access_tokens",
+          "repositories_url": "https://api.github.com/installation/repositories",
+          "html_url": "https://github.com/settings/installations/957387",
+          "app_id": 29310,
+          "target_id": 21031067,
+          "target_type": "User",
+          "permissions": {
+            "administration": "write",
+            "checks": "write",
+            "contents": "write",
+            "deployments": "write",
+            "issues": "write",
+            "pages": "write",
+            "pull_requests": "write",
+            "repository_hooks": "write",
+            "repository_projects": "write",
+            "statuses": "write",
+            "metadata": "read",
+            "vulnerability_alerts": "read"
+          },
+          "events": [],
+          "created_at": 1557933591,
+          "updated_at": 1557933591,
+          "single_file_name": null
+        },
+        "repositories": [
+          {
+            "id": 186853002,
+            "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+            "name": "Hello-World",
+            "full_name": "Codertocat/Hello-World",
+            "private": false
+          }
+        ],
+        "requester": {
+          "login": "Codertocat",
+          "id": 21031067,
+          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+          "gravatar_id": "",
+          "url": "https://api.github.com/users/Codertocat",
+          "html_url": "https://github.com/Codertocat",
+          "followers_url": "https://api.github.com/users/Codertocat/followers",
+          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+          "repos_url": "https://api.github.com/users/Codertocat/repos",
+          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+          "type": "User",
+          "site_admin": false
+        },
+        "sender": {
+          "login": "Codertocat",
+          "id": 21031067,
+          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+          "gravatar_id": "",
+          "url": "https://api.github.com/users/Codertocat",
+          "html_url": "https://github.com/Codertocat",
+          "followers_url": "https://api.github.com/users/Codertocat/followers",
+          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+          "repos_url": "https://api.github.com/users/Codertocat/repos",
+          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+          "type": "User",
+          "site_admin": false
+        }
+      },
       {
         "action": "deleted",
         "installation": {

diff --git a/payload-examples/api.github.com/installation/created.with-requester.payload.json b/payload-examples/api.github.com/installation/created.with-requester.payload.json
@@ -0,0 +1,100 @@
+{
+  "action": "created",
+  "installation": {
+    "id": 957387,
+    "account": {
+      "login": "Codertocat",
+      "id": 21031067,
+      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/Codertocat",
+      "html_url": "https://github.com/Codertocat",
+      "followers_url": "https://api.github.com/users/Codertocat/followers",
+      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+      "repos_url": "https://api.github.com/users/Codertocat/repos",
+      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "repository_selection": "selected",
+    "access_tokens_url": "https://api.github.com/app/installations/957387/access_tokens",
+    "repositories_url": "https://api.github.com/installation/repositories",
+    "html_url": "https://github.com/settings/installations/957387",
+    "app_id": 29310,
+    "target_id": 21031067,
+    "target_type": "User",
+    "permissions": {
+      "administration": "write",
+      "checks": "write",
+      "contents": "write",
+      "deployments": "write",
+      "issues": "write",
+      "pages": "write",
+      "pull_requests": "write",
+      "repository_hooks": "write",
+      "repository_projects": "write",
+      "statuses": "write",
+      "metadata": "read",
+      "vulnerability_alerts": "read"
+    },
+    "events": [],
+    "created_at": 1557933591,
+    "updated_at": 1557933591,
+    "single_file_name": null
+  },
+  "repositories": [
+    {
+      "id": 186853002,
+      "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+      "name": "Hello-World",
+      "full_name": "Codertocat/Hello-World",
+      "private": false
+    }
+  ],
+  "requester": {
+    "login": "Codertocat",
+    "id": 21031067,
+    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/Codertocat",
+    "html_url": "https://github.com/Codertocat",
+    "followers_url": "https://api.github.com/users/Codertocat/followers",
+    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+    "repos_url": "https://api.github.com/users/Codertocat/repos",
+    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "sender": {
+    "login": "Codertocat",
+    "id": 21031067,
+    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/Codertocat",
+    "html_url": "https://github.com/Codertocat",
+    "followers_url": "https://api.github.com/users/Codertocat/followers",
+    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+    "repos_url": "https://api.github.com/users/Codertocat/repos",
+    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+    "type": "User",
+    "site_admin": false
+  }
+}
diff --git a/payload-schemas/schemas/installation/created.schema.json b/payload-schemas/schemas/installation/created.schema.json
@@ -31,7 +31,7 @@
         "additionalProperties": false
       }
     },
-    "requester": { "type": "null" },
+    "requester": { "$ref": "common/user.schema.json" },
     "sender": { "$ref": "common/user.schema.json" }
   },
   "additionalProperties": false,

diff --git a/payload-schemas/schemas/installation_repositories/added.schema.json b/payload-schemas/schemas/installation_repositories/added.schema.json
@@ -68,6 +68,7 @@
       },
       "maxItems": 0
     },
+    "requester": { "$ref": "common/user.schema.json" },
     "sender": { "$ref": "common/user.schema.json" }
   },
   "additionalProperties": false,

diff --git a/schema.d.ts b/schema.d.ts
@@ -2227,7 +2227,7 @@ export interface InstallationCreatedEvent {
      */
     private: boolean;
   }[];
-  requester?: null;
+  requester?: User;
   sender: User;
 }
 /**
@@ -2408,6 +2408,7 @@ export interface InstallationRepositoriesAddedEvent {
    * An array of repository objects, which were removed from the installation.
    */
   repositories_removed: [];
+  requester?: User;
   sender: User;
 }
 export interface InstallationRepositoriesRemovedEvent {