fix(typescript): descripion & response types fixes (#1561)

octokit · Jan 29, 2020 · 7c64d9c · 7c64d9c
1 parent a706b0d
commit 7c64d9c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 52 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -342,15 +342,7 @@ declare namespace Octokit {
     visibility: string;
   };
   type UsersListPublicKeysForUserResponseItem = { id: number; key: string };
-  type UsersListPublicKeysResponseItem = {
-    created_at: string;
-    id: number;
-    key: string;
-    read_only: boolean;
-    title: string;
-    url: string;
-    verified: boolean;
-  };
+  type UsersListPublicKeysResponseItem = { key: string; key_id: string };
   type UsersListPublicEmailsResponseItem = {
     email: string;
     primary: boolean;
@@ -547,15 +539,7 @@ declare namespace Octokit {
     type: string;
     url: string;
   };
-  type UsersGetPublicKeyResponse = {
-    created_at: string;
-    id: number;
-    key: string;
-    read_only: boolean;
-    title: string;
-    url: string;
-    verified: boolean;
-  };
+  type UsersGetPublicKeyResponse = { key: string; key_id: string };
   type UsersGetGpgKeyResponseSubkeysItem = {
     can_certify: boolean;
     can_encrypt_comms: boolean;
@@ -678,15 +662,7 @@ declare namespace Octokit {
     updated_at: string;
     url: string;
   };
-  type UsersCreatePublicKeyResponse = {
-    created_at: string;
-    id: number;
-    key: string;
-    read_only: boolean;
-    title: string;
-    url: string;
-    verified: boolean;
-  };
+  type UsersCreatePublicKeyResponse = { key: string; key_id: string };
   type UsersCreateGpgKeyResponseSubkeysItem = {
     can_certify: boolean;
     can_encrypt_comms: boolean;
@@ -24266,10 +24242,6 @@ declare namespace Octokit {
     expires_at: string;
     token: string;
   };
-  type ActionsCreateOrUpdateSecretForRepoResponse = {
-    encrypted_value: string;
-    key_id: string;
-  };
   type ActionsListJobsForWorkflowRunResponse = Array<
     ActionsListJobsForWorkflowRunResponseItem
   >;
@@ -24668,7 +24640,7 @@ declare namespace Octokit {
     /**
      * ID of the key you used to encrypt the secret.
      */
-    key_id?: number;
+    key_id?: string;
 
     name: string;
 
@@ -33757,9 +33729,7 @@ declare class Octokit {
       (
         params?: Octokit.RequestOptions &
           Octokit.ActionsCreateOrUpdateSecretForRepoParams
-      ): Promise<
-        Octokit.Response<Octokit.ActionsCreateOrUpdateSecretForRepoResponse>
-      >;
+      ): Promise<Octokit.AnyResponse>;
 
       endpoint: Octokit.Endpoint;
     };
@@ -37724,7 +37694,7 @@ declare class Octokit {
       endpoint: Octokit.Endpoint;
     };
     /**
-     * **Note:** The response includes a maximum of 300 files.
+     * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
      */
     listFiles: {
       (

diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
@@ -13925,7 +13925,7 @@
         "name": "key_id",
         "description": "ID of the key you used to encrypt the secret.",
         "in": "BODY",
-        "type": "integer",
+        "type": "string",
         "required": false,
         "enum": null,
         "allowNull": false,
@@ -13935,17 +13935,7 @@
         "deprecated": null
       }
     ],
-    "responses": [
-      {
-        "code": 201,
-        "description": "response",
-        "examples": [
-          {
-            "data": "{\"encrypted_value\":\"QIvLrNh6tmhUxABczx2vnsncsIj2KiwitqIVpXN9bU3DsHJ1srExk/DrgRaXCAwJnsdsmjo1KwQ=\",\"key_id\":\"1234\"}"
-          }
-        ]
-      }
-    ],
+    "responses": [],
     "renamed": null
   },
   {
@@ -33287,7 +33277,7 @@
     "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files",
     "isDeprecated": false,
     "isLegacy": false,
-    "description": "**Note:** The response includes a maximum of 300 files.",
+    "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.",
     "documentationUrl": "https://developer.github.com/v3/pulls/#list-pull-requests-files",
     "previews": [],
     "headers": [],
@@ -44240,7 +44230,7 @@
         "description": "response",
         "examples": [
           {
-            "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/user/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}]"
+            "data": "[{\"key_id\":\"1234\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}]"
           }
         ]
       }
@@ -44293,7 +44283,7 @@
         "description": "response",
         "examples": [
           {
-            "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/user/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}"
+            "data": "{\"key_id\":\"1234\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}"
           }
         ]
       }
@@ -44333,7 +44323,7 @@
         "description": "response",
         "examples": [
           {
-            "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/user/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}"
+            "data": "{\"key_id\":\"1234\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}"
           }
         ]
       }