fix(deps): bump @octokit/plugin-rest-endpoints to 4.3.0 (#1948)

* fix(deps): bump @octokit/plugin-rest-endpoints to 4.3.0 ([changelogs](https://github.com/octokit/plugin-rest-endpoint-methods.js/releases/tag/v4.3.0))

* build(deps): update to latest

* docs: `:param` url notation is now `{param}`

* test: adapt for latest `@octokit/types`

Author: gr2m

HOW_IT_WORKS.md

@@ -15,7 +15,7 @@
 
 ## Endpoint options (① - ④)
 
-`@octokit/rest` exposes a method for each [REST API endpoint](https://docs.github.com/en/rest/reference/), for example `octokit.repos.listForOrg()` for [`GET /orgs/:org/repos`](https://docs.github.com/en/rest/reference/repos/#list-organization-repositories). The methods are generated in [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/). The [`src/generated/endpoints.ts` file](https://github.com/octokit/plugin-rest-endpoint-methods.js/blob/master/src/generated/endpoints.ts) defines the **② endpoint default options** `method`, `url`, and in some cases `mediaType` and `headers`.
+`@octokit/rest` exposes a method for each [REST API endpoint](https://docs.github.com/en/rest/reference/), for example `octokit.repos.listForOrg()` for [`GET /orgs/{org}/repos`](https://docs.github.com/en/rest/reference/repos/#list-organization-repositories). The methods are generated in [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/). The [`src/generated/endpoints.ts` file](https://github.com/octokit/plugin-rest-endpoint-methods.js/blob/master/src/generated/endpoints.ts) defines the **② endpoint default options** `method`, `url`, and in some cases `mediaType` and `headers`.
 
 **② endpoint default options** are merged with **① global defaults**, which are based on [@octokit/endpoint/src/defaults.ts](https://github.com/octokit/endpoint.js/blob/master/src/defaults.ts) and the options that were passed into the `new Octokit(options)` constructor.
 
@@ -59,7 +59,7 @@ octokit.repos.listForOrg({ org: "octokit", type: "public" });
   </tr>
   <tr>
     <td><strong>url</strong></td>
-    <td><code>'/orgs/:org/repos'</code></td>
+    <td><code>'/orgs/{org}/repos'</code></td>
     <td>② endpoint defaults</td>
   </tr>
   <tr>

docs/src/pages/api/05_pagination.md

@@ -8,7 +8,7 @@ To automatically receive all results across all pages, you can use the `octokit.
 
 ```js
 octokit
-  .paginate("GET /repos/:owner/:repo/issues", {
+  .paginate("GET /repos/{owner}/{repo}/issues", {
     owner: "octokit",
     repo: "rest.js",
   })
@@ -25,7 +25,7 @@ octokit
 ```js
 octokit
   .paginate(
-    "GET /repos/:owner/:repo/issues",
+    "GET /repos/{owner}/{repo}/issues",
     { owner: "octokit", repo: "rest.js" },
     (response) => response.data.map((issue) => issue.title)
   )

docs/src/pages/api/07_custom_endpoints.md

@@ -49,7 +49,7 @@ octokit.registerEndpoints({
   foo: {
     bar: {
       method: "PATCH",
-      url: "/repos/:owner/:repo/foo",
+      url: "/repos/{owner}/{repo}/foo",
       headers: {
         accept: "application/vnd.github.foo-bar-preview+json",
       },

package-lock.json

@@ -32,10 +32,10 @@
   ],
   "repository": "https://github.com/octokit/rest.js",
   "dependencies": {
-    "@octokit/core": "^3.0.0",
-    "@octokit/plugin-paginate-rest": "^2.2.0",
-    "@octokit/plugin-request-log": "^1.0.0",
-    "@octokit/plugin-rest-endpoint-methods": "4.2.1"
+    "@octokit/core": "^3.2.2",
+    "@octokit/plugin-paginate-rest": "^2.6.1",
+    "@octokit/plugin-request-log": "^1.0.2",
+    "@octokit/plugin-rest-endpoint-methods": "4.3.0"
   },
   "devDependencies": {
     "@octokit/auth": "^2.0.0",

package.json

@@ -137,7 +137,7 @@ describe("deprecations", () => {
     expect(url).to.equal(
       "https://api.github.com/repos/octocat/hello-world/issues/123"
     );
-    expect(options.url).to.equal("/repos/:owner/:repo/issues/:issue_number");
+    expect(options.url).to.equal("/repos/{owner}/{repo}/issues/{issue_number}");
     expect("number" in options).to.equal(false);
     expect(options.issue_number).to.equal(123);
     expect(warnCalledCount).to.equal(2);
@@ -1072,7 +1072,7 @@ describe("deprecations", () => {
   /**
    * There is a special case for OAuth applications, when `clientId` and `clientSecret` is passed as
    * Basic Authorization instead of query parameters. The only routes where that applies share the same
-   * URL though: `/applications/:client_id/tokens/:access_token`. We identify this acception by looking
+   * URL though: `/applications/{client_id}/tokens/{access_token}`. We identify this acception by looking
    * for this path.
    *
    *  1. [Check an authorization](https://docs.github.com/en/rest/reference/apps/#check-an-authorization)
@@ -1107,15 +1107,15 @@ describe("deprecations", () => {
 
     return Promise.all([
       octokit.request(
-        "GET /applications/:client_id/tokens/:access_token",
+        "GET /applications/{client_id}/tokens/{access_token}",
         options
       ),
       octokit.request(
-        "POST /applications/:client_id/tokens/:access_token",
+        "POST /applications/{client_id}/tokens/{access_token}",
         options
       ),
       octokit.request(
-        "DELETE /applications/:client_id/tokens/:access_token",
+        "DELETE /applications/{client_id}/tokens/{access_token}",
         options
       ),
     ]);

test/integration/deprecations-test.js

@@ -177,7 +177,7 @@ describe("pagination", () => {
     const iterator = octokit.paginate
       .iterator({
         method: "GET",
-        url: "/orgs/:org",
+        url: "/orgs/{org}",
         org: "myorg",
       })
       [Symbol.asyncIterator]();

test/integration/pagination-test.js

@@ -39,7 +39,7 @@ describe("registerEndpoints", () => {
               type: "string",
             },
           },
-          url: "/repos/:owner/:repo/issues/:issue_number",
+          url: "/repos/{owner}/{repo}/issues/{issue_number}",
         },
       },
     });

test/integration/register-endpoints-test.js

@@ -24,15 +24,15 @@ describe("https://github.com/octokit/rest.js/issues/881", () => {
     });
 
     return octokit.repos
-      .downloadArchive({
+      .downloadTarballArchive({
         method: "HEAD",
         owner: "octocat",
         repo: "Hello-World",
-        archive_format: "tarball",
         ref: "master",
       })
 
       .then((response) => {
+        // @ts-ignore https://github.com/octokit/types.ts/issues/211
         expect(response.url).toEqual(
           "https://issue-881-codeload.github.com/octocat/Hello-World/legacy.tar.gz/master"
         );

test/issues/881-redirect-url.test.ts

@@ -24,6 +24,7 @@ describe("api.github.com", () => {
       })
 
       .then((response) => {
+        // @ts-ignore https://github.com/github/rest-api-description/issues/107
         expect(response.data.content.type).toEqual("file");
       });
   });

test/scenarios/create-file.test.ts

@@ -15,16 +15,16 @@ describe("api.github.com", () => {
     return it.skip("octokit.repos.archive() (#758)");
   }
 
-  it('octokit.repos.archive({owner: "octokit-fixture-org", repo: "get-archive"})', () => {
+  it('octokit.repos.downloadTarballArchive({owner: "octokit-fixture-org", repo: "get-archive"})', () => {
     return octokit.repos
-      .downloadArchive({
+      .downloadTarballArchive({
         owner: "octokit-fixture-org",
         repo: "get-archive",
-        archive_format: "tarball",
         ref: "main",
       })
 
       .then((response) => {
+        // @ts-ignore https://github.com/octokit/types.ts/issues/211
         expect(response.data.byteLength).toEqual(172);
       });
   });

test/scenarios/get-archive.test.ts

@@ -19,6 +19,7 @@ describe("api.github.com", () => {
       })
 
       .then((response) => {
+        // @ts-ignore unclear what causes "Object is possibly 'null'" TypeScript error
         expect(response.data.owner.login).toEqual("octokit-fixture-org");
       });
   });

test/scenarios/get-repository.test.ts

@@ -57,10 +57,6 @@ describe("api.github.com", () => {
           repo: "labels",
           name: "test-label-updated",
         });
-      })
-
-      .then((result) => {
-        expect(result.data).toEqual(undefined);
       });
   });
 });

test/scenarios/labels.test.ts

@@ -106,35 +106,35 @@ export default async function () {
 
   // request & endpoint
   octokit.request("/");
-  octokit.request("GET /repos/:owner/:repo/issues", {
+  octokit.request("GET /repos/{owner}/{repo}/issues", {
     owner: "octokit",
     repo: "rest.js",
   });
   octokit.request({
     method: "GET",
-    url: "/repos/:owner/:repo/issues",
+    url: "/repos/{owner}/{repo}/issues",
     owner: "octokit",
     repo: "rest.js",
   });
   octokit.request.endpoint("/");
-  octokit.request.endpoint("GET /repos/:owner/:repo/issues", {
+  octokit.request.endpoint("GET /repos/{owner}/{repo}/issues", {
     owner: "octokit",
     repo: "rest.js",
   });
   octokit.request.endpoint({
     method: "GET",
-    url: "/repos/:owner/:repo/issues",
+    url: "/repos/{owner}/{repo}/issues",
     owner: "octokit",
     repo: "rest.js",
   });
   octokit.request.endpoint.merge({ foo: "bar" });
   octokit.request.endpoint
     .defaults({ owner: "octokit", repo: "rest.js" })
-    .merge({ method: "GET", url: "/repos/:owner/:repo/issues" });
+    .merge({ method: "GET", url: "/repos/{owner}/{repo}/issues" });
 
   // pagination
   octokit
-    .paginate("GET /repos/:owner/:repo/issues", {
+    .paginate("GET /repos/{owner}/{repo}/issues", {
       owner: "octokit",
       repo: "rest.js",
     })
@@ -144,7 +144,7 @@ export default async function () {
 
   octokit
     .paginate(
-      "GET /repos/:owner/:repo/issues",
+      "GET /repos/{owner}/{repo}/issues",
       { owner: "octokit", repo: "rest.js" },
       (response) => response.data.map((issue) => issue.title)
     )
@@ -238,7 +238,7 @@ export default async function () {
         name: "bug",
         url: "",
       },
-      status: 201,
+      status: 200,
       url: "",
     };
   }