Use OpenAPI descriptions instead of octokit/routes

.github/workflows/build.yml

@@ -37,6 +37,8 @@ jobs:
         npm ci
 
     - name: Test
+      env:
+        GITHUB_TOKEN: 987zyx
       run: |
         npm run lint
         npm test

index.js

@@ -1,17 +1,18 @@
 #!/usr/bin/env node
 const path = require('path');
-const fs = require('fs');
-const routes = require('@octokit/routes');
+const fs = require('fs/promises');
 const meta = require('./package');
-const generate = require('./lib/generate');
+const { generate, getLatestRoutes } = require('./lib/generate');
 
-Object.entries(routes).forEach(([route, api]) => {
-  const data = generate({ api, meta });
-  const destination = path.normalize(path.join(__dirname, 'routes', `${route}.json`));
+(async () => {
+  const routes = await getLatestRoutes();
 
-  // Write output straight to file
-  const output = JSON.stringify(data, null, 2);
-  fs.writeFileSync(destination, output);
-});
+  Object.entries(routes).forEach(async ([route, api]) => {
+    const data = generate({ api, meta });
+    const destination = path.normalize(path.join(__dirname, 'routes', `${route}.json`));
 
-process.exit(0);
+    // Write output straight to file
+    const output = JSON.stringify(data, null, 2);
+    await fs.writeFile(destination, output);
+  });
+})();

lib/generate.js

@@ -1,12 +1,32 @@
 const _ = require('lodash');
 const { idGenerator } = require('./id-generator');
 const { generateEnvironmentVariables, generateRequestGroups, generateRequests } = require('./generators');
+const { Octokit } = require('@octokit/rest');
+
+const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });
+const owner = 'github';
+const repo = 'rest-api-description';
 
 const fldIdGenerator = idGenerator('FLD');
 const reqIdGenerator = idGenerator('REQ');
 
-function generate({ api, meta }) {
-  // eslint-disable-next-line no-underscore-dangle
+const getContentAtPath = async (path) => {
+  return await octokit.repos.getContent({
+    owner,
+    repo,
+    path
+  });
+};
+
+const getFileContent = async (sha) => {
+  return await octokit.git.getBlob({
+    owner,
+    repo,
+    file_sha: sha
+  });
+};
+
+const generate = ({ api, meta }) => {
   const _api = _(api);
 
   const rootRequestGroup = {
@@ -35,6 +55,24 @@ function generate({ api, meta }) {
   };
 
   return data;
-}
+};
+
+const getLatestRoutes = async () => {
+  const routes = {};
+  const { data: platforms } = await getContentAtPath('descriptions');
+
+  await Promise.all(platforms.map(async platform => {
+    const { data: files } = await getContentAtPath(platform.path + '/dereferenced');
+    const file = files.find(f => f.name.indexOf('json') >= 0);
+    const { data: blob } = await getFileContent(file.sha);
+    const content = Buffer.from(blob.content, 'base64').toString('utf-8');
+    routes[platform.name] = JSON.parse(content);
+  }));
+
+  return routes;
+};
 
-module.exports = generate;
+module.exports = {
+  generate,
+  getLatestRoutes
+};

lib/generators.js

@@ -1,7 +1,7 @@
 const _ = require('lodash');
 const { requestGroupNameFromSpec, queryParamsFromSpec, previewHeadersFromSpec } = require('./helpers');
 
-function generateEnvironmentVariables(api) {
+function generateEnvironmentVariables (api) {
   // Use a set so that we de-duplicate
   const environmentVariables = new Set();
 
@@ -13,7 +13,10 @@ function generateEnvironmentVariables(api) {
 
   Object.values(api.paths).forEach(methods => {
     Object.values(methods).forEach(spec => {
-      spec.parameters
+      if (!spec.parameters) {
+        return [];
+      }
+      return spec.parameters
         .filter(param => param.in === 'path')
         .forEach(({ name, schema }) => {
           // Add each environment variable as a key-value pair, initialize the value to default
@@ -27,7 +30,7 @@ function generateEnvironmentVariables(api) {
 }
 module.exports.generateEnvironmentVariables = generateEnvironmentVariables;
 
-function generateRequestGroups(api, idGenerator, parentId) {
+function generateRequestGroups (api, idGenerator, parentId) {
   const groups = new Set();
 
   Object.values(api.paths).forEach(methods => {
@@ -45,7 +48,7 @@ function generateRequestGroups(api, idGenerator, parentId) {
 }
 module.exports.generateRequestGroups = generateRequestGroups;
 
-function generateRequests(api, idGenerator, requestGroups) {
+function generateRequests (api, idGenerator, requestGroups) {
   const requests = [];
 
   // Generate an index of requestGroups by group
@@ -79,7 +82,7 @@ function generateRequests(api, idGenerator, requestGroups) {
         _id: idGenerator(),
         _type: 'request',
         name: spec.summary,
-        description: `${spec.description}\n\n${spec.externalDocs.url}`,
+        description: spec.externalDocs ? `${spec.description}\n\n${spec.externalDocs.url}` : '',
         headers,
         authentication: {
           token: '{{ github_token }}',

lib/helpers.js

@@ -1,9 +1,12 @@
-function requestGroupNameFromSpec(spec) {
+function requestGroupNameFromSpec (spec) {
   return spec.operationId.split('/')[0];
 }
 module.exports.requestGroupNameFromSpec = requestGroupNameFromSpec;
 
-function queryParamsFromSpec(spec) {
+function queryParamsFromSpec (spec) {
+  if (!spec.parameters) {
+    return [];
+  }
   return spec.parameters
     .filter(param => param.in === 'query')
     .map(({ name, schema }) => {
@@ -16,8 +19,8 @@ function queryParamsFromSpec(spec) {
 }
 module.exports.queryParamsFromSpec = queryParamsFromSpec;
 
-function previewHeadersFromSpec(spec) {
-  return spec['x-github'].previews.length
+function previewHeadersFromSpec (spec) {
+  return spec['x-github'] && spec['x-github'].previews && spec['x-github'].previews.length
     ? {
         name: 'Accept',
         value: spec['x-github'].previews.map(preview => `application/vnd.github.${preview.name}-preview+json`).join(',')

lib/id-generator.js

@@ -1,6 +1,6 @@
-function idGenerator(kind, initial = 1, increment = 1) {
+function idGenerator (kind, initial = 1, increment = 1) {
   let current = initial;
-  return function generateId() {
+  return function generateId () {
     const id = `__${kind}_${current}__`;
     current += increment;
     return id;