fix: adapt for latest @octokit/types

Author: gr2m

README.md

@@ -38,7 +38,7 @@ the passed options and sends the request using [fetch](https://developer.mozilla
 🤩 1:1 mapping of REST API endpoint documentation, e.g. [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue) becomes
 
 ```js
-request("POST /repos/:owner/:repo/issues/:number/labels", {
+request("POST /repos/{owner}/{repo}/issues/{number}/labels", {
   mediaType: {
     previews: ["symmetra"],
   },
@@ -99,7 +99,7 @@ const { request } = require("@octokit/request");
 ```js
 // Following GitHub docs formatting:
 // https://developer.github.com/v3/repos/#list-organization-repositories
-const result = await request("GET /orgs/:org/repos", {
+const result = await request("GET /orgs/{org}/repos", {
   headers: {
     authorization: "token 0000000000000000000000000000000000000001",
   },
@@ -139,7 +139,7 @@ Alternatively, pass in a method and a url
 ```js
 const result = await request({
   method: "GET",
-  url: "/orgs/:org/repos",
+  url: "/orgs/{org}/repos",
   headers: {
     authorization: "token 0000000000000000000000000000000000000001",
   },
@@ -180,11 +180,14 @@ const requestWithAuth = request.defaults({
 });
 
 const { data: app } = await requestWithAuth("GET /app");
-const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", {
-  owner: "octocat",
-  repo: "hello-world",
-  title: "Hello from the engine room",
-});
+const { data: app } = await requestWithAuth(
+  "POST /repos/{owner}/{repo}/issues",
+  {
+    owner: "octocat",
+    repo: "hello-world",
+    title: "Hello from the engine room",
+  }
+);
 ```
 
 ## request()
@@ -215,7 +218,7 @@ const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", {
       String
     </td>
     <td>
-      If <code>route</code> is set it has to be a string consisting of the request method and URL, e.g. <code>GET /orgs/:org</code>
+      If <code>route</code> is set it has to be a string consisting of the request method and URL, e.g. <code>GET /orgs/{org}</code>
     </td>
   </tr>
   <tr>
@@ -283,7 +286,7 @@ const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", {
     </td>
     <td>
       <strong>Required.</strong> A path or full URL which may contain <code>:variable</code> or <code>{variable}</code> placeholders,
-      e.g. <code>/orgs/:org/repos</code>. The <code>url</code> is parsed using <a href="https://github.com/bramstein/url-template">url-template</a>.
+      e.g. <code>/orgs/{org}/repos</code>. The <code>url</code> is parsed using <a href="https://github.com/bramstein/url-template">url-template</a>.
     </td>
   </tr>
   <tr>
@@ -356,7 +359,7 @@ const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", {
 
 All other options except `options.request.*` will be passed depending on the `method` and `url` options.
 
-1. If the option key is a placeholder in the `url`, it will be used as replacement. For example, if the passed options are `{url: '/orgs/:org/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos`
+1. If the option key is a placeholder in the `url`, it will be used as replacement. For example, if the passed options are `{url: '/orgs/{org}/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos`
 2. If the `method` is `GET` or `HEAD`, the option is passed as query parameter
 3. Otherwise the parameter is passed in the request body as JSON key.
 
@@ -421,7 +424,7 @@ const myrequest = require("@octokit/request").defaults({
   per_page: 100,
 });
 
-myrequest(`GET /orgs/:org/repos`);
+myrequest(`GET /orgs/{org}/repos`);
 ```
 
 You can call `.defaults()` again on the returned method, the defaults will cascade.
@@ -450,7 +453,7 @@ by the global default.
 See https://github.com/octokit/endpoint.js. Example
 
 ```js
-const options = request.endpoint("GET /orgs/:org/repos", {
+const options = request.endpoint("GET /orgs/{org}/repos", {
   org: "my-project",
   type: "private",
 });

test/defaults.test.ts

@@ -35,7 +35,7 @@ describe("endpoint.defaults()", () => {
       },
     });
 
-    return myRequest(`GET /orgs/:org/repos`).then((response) => {
+    return myRequest(`GET /orgs/{org}/repos`).then((response) => {
       expect(response.status).toEqual(200);
     });
   });
@@ -76,8 +76,10 @@ describe("endpoint.defaults()", () => {
       },
     });
 
-    return myProjectRequestWithAuth(`GET /orgs/:org/repos`).then((response) => {
-      expect(response.status).toEqual(200);
-    });
+    return myProjectRequestWithAuth(`GET /orgs/{org}/repos`).then(
+      (response) => {
+        expect(response.status).toEqual(200);
+      }
+    );
   });
 });

test/request.test.ts

@@ -29,7 +29,7 @@ describe("request()", () => {
         },
       });
 
-    return request("GET /orgs/:org/repos", {
+    return request("GET /orgs/{org}/repos", {
       headers: {
         authorization: "token 0000000000000000000000000000000000000001",
       },
@@ -50,7 +50,7 @@ describe("request()", () => {
 
     return request({
       method: "GET",
-      url: "/orgs/:org/repos",
+      url: "/orgs/{org}/repos",
       headers: {
         authorization: "token 0000000000000000000000000000000000000001",
       },
@@ -147,7 +147,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       },
     });
     await requestWithAuth("GET /app");
-    await requestWithAuth("POST /repos/:owner/:repo/issues", {
+    await requestWithAuth("POST /repos/{owner}/{repo}/issues", {
       owner: "octocat",
       repo: "hello-world",
       title: "Hello from the engine room",
@@ -165,7 +165,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
         },
       });
 
-    request("POST /repos/:owner/:repo/issues", {
+    request("POST /repos/{owner}/{repo}/issues", {
       owner: "octocat",
       repo: "hello-world",
       headers: {
@@ -193,7 +193,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
         },
       });
 
-    request("PUT /user/starred/:owner/:repo", {
+    request("PUT /user/starred/{owner}/{repo}", {
       headers: {
         authorization: `token 0000000000000000000000000000000000000001`,
       },
@@ -234,12 +234,12 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       },
     };
 
-    request(`HEAD /repos/:owner/:repo/pulls/:number`, options)
+    request(`HEAD /repos/{owner}/{repo}/pulls/{number}`, options)
       .then((response) => {
         expect(response.status).toEqual(200);
 
         return request(
-          `HEAD /repos/:owner/:repo/pulls/:number`,
+          `HEAD /repos/{owner}/{repo}/pulls/{number}`,
           Object.assign(options, { number: 2 })
         );
       })
@@ -271,7 +271,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
         }
       );
 
-    return request("GET /repos/:owner/:repo/:archive_format/:ref", {
+    return request("GET /repos/{owner}/{repo}/{archive_format}/{ref}", {
       owner: "octokit-fixture-org",
       repo: "get-archive",
       archive_format: "tarball",
@@ -324,7 +324,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       );
     }, 304);
 
-    return request("GET /orgs/:org", {
+    return request("GET /orgs/{org}", {
       org: "myorg",
       headers: { "If-None-Match": "etag" },
       request: {
@@ -349,7 +349,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       );
     }, 304);
 
-    return request("GET /orgs/:org", {
+    return request("GET /orgs/{org}", {
       org: "myorg",
       headers: {
         "If-Modified-Since": "Sun Dec 24 2017 22:00:00 GMT-0600 (CST)",
@@ -369,7 +369,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
   it("Not found", () => {
     const mock = fetchMock.sandbox().get("path:/orgs/nope", 404);
 
-    return request("GET /orgs/:org", {
+    return request("GET /orgs/{org}", {
       org: "nope",
       request: {
         fetch: mock,
@@ -398,7 +398,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
         },
       });
 
-    return request("GET /repos/:owner/:repo/contents/:path", {
+    return request("GET /repos/{owner}/{repo}/contents/{path}", {
       headers: {
         accept: "application/vnd.github.v3.raw",
       },
@@ -670,7 +670,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
         },
       });
 
-    return request("GET /repos/:owner/:repo/issues/:number", {
+    return request("GET /repos/{owner}/{repo}/issues/{number}", {
       headers: {
         authorization: "token 0000000000000000000000000000000000000001",
       },
@@ -700,7 +700,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
         },
       });
 
-    return request("GET /repos/:owner/:repo/issues/:number", {
+    return request("GET /repos/{owner}/{repo}/issues/{number}", {
       headers: {
         authorization: "token 0000000000000000000000000000000000000001",
       },
@@ -742,7 +742,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       }
     );
 
-    return request("PUT /repos/:owner/:repo/branches/:branch/protection", {
+    return request("PUT /repos/{owner}/{repo}/branches/{branch}/protection", {
       baseUrl: "https://request-errors-test.com",
       mediaType: { previews: ["luke-cage"] },
       headers: {