feat: replace @octokit/routes with latest OpenAPI spec via `@octoki…

…t/openapi` (#58)

api/_lib/parse-operation.js

@@ -78,7 +78,6 @@ function parseOperation({ method, url }, operation) {
   const headerParameters = operation.parameters.filter(
     param => param.in === "header"
   );
-  const acceptHeader = headerParameters.find(param => param.name === "accept");
   const headers = headerParameters
     .filter(param => param.name !== "accept")
     .map(toHeader);
@@ -149,41 +148,17 @@ function parseOperation({ method, url }, operation) {
   }
 
   const endpoint = {
-    id,
-    scope,
     name: operation.summary,
     description: operation.description,
     method: method.toUpperCase(),
     url,
     parameters,
     headers,
     documentationUrl: operation.externalDocs.url,
-    isDeprecated: !!operation.deprecated,
-    isLegacy: operation["x-github"].legacy,
-    isEnabledForApps: operation["x-github"].enabledForApps,
-    isGithubCloudOnly: operation["x-github"].githubCloudOnly,
-    triggersNotification: operation["x-github"].triggersNotification,
     previews: operation["x-github"].previews,
-    responses,
-    changes: operation["x-changes"].map(change => {
-      const type = change.type.toUpperCase();
-      const before = toParamter(type, change.before);
-      const after = toParamter(type, change.after);
-
-      return {
-        type,
-        date: change.date,
-        note: change.note,
-        before,
-        after
-      };
-    })
+    responses
   };
 
-  if (acceptHeader.required) {
-    endpoint.headers.unshift(toHeader(acceptHeader));
-  }
-
   return endpoint;
 }
 

api/search.js

@@ -18,20 +18,20 @@ module.exports = async (request, response) => {
         const operation = OPENAPI_PATHS[endpointPath][method.toLowerCase()];
         if (!operation) continue;
 
-        results.push([method, endpointPath, operation]);
+        results.push([method, endpointPath, toSearchData(operation)]);
         continue;
       }
 
       for (const [method, operation] of Object.entries(
         OPENAPI_PATHS[endpointPath]
       )) {
         if (path) {
-          results.push([method.toUpperCase(), endpointPath, operation]);
+          results.push([method.toUpperCase(), endpointPath, toSearchData(operation)]);
           continue;
         }
 
         if (queryRegex.test(operation.summary)) {
-          results.push([method.toUpperCase(), endpointPath, operation]);
+          results.push([method.toUpperCase(), endpointPath, toSearchData(operation)]);
         }
       }
     }
@@ -88,3 +88,12 @@ function toMethodAndPath(query) {
 
   return {};
 }
+
+/**
+ * only return data that is actually needed for search results
+ */
+function toSearchData(operation) {
+  return {
+    summary: operation.summary
+  }
+}

package.json

@@ -9,11 +9,11 @@
     "node": "12.x"
   },
   "dependencies": {
+    "@octokit/openapi": "^2.2.1",
     "@octokit/request": "^5.3.2",
     "markdown-it": "^10.0.0"
   },
   "devDependencies": {
-    "@octokit/routes": "29.0.0",
     "cypress": "^4.7.0",
     "semantic-release": "^17.2.3",
     "vercel": "^20.1.1"