Function buildOpenAPI

scripts/build-open-api.js:60–323

(
  externalHTTPRoutes = [],
  externalWebSocketRoutes = [],
  disabledRoutes = [],
)

};

const buildOpenAPI = async (
  externalHTTPRoutes = [],
  externalWebSocketRoutes = [],
  disabledRoutes = [],
) => {
  const [{ getRouteFiles }, { Config }, { errorCodes }, packageJSON] =
    await Promise.all([
      import('../build/utils.js'),
      import('../build/config.js'),
      import('../build/http.js'),
      fs.readFile(packageJSONPath),
    ]);

  const isWin = process.platform === 'win32';
  const readme = (await fs.readFile('README.md').catch(() => '')).toString();
  const changelog = marked.parse(
    (await fs.readFile('CHANGELOG.md').catch(() => '')).toString(),
  );

  const [httpRoutes, wsRoutes] = await getRouteFiles(new Config());
  const swaggerJSON = {
    customSiteTitle: 'Browserless Documentation',
    definitions: {},
    info: {
      title: 'Browserless',
      version: JSON.parse(packageJSON.toString()).version,
      'x-logo': {
        altText: 'browserless logo',
        url: './docs/browserless-logo-inline.svg',
      },
    },
    openapi: '3.0.0',
    paths: {},
    servers: [],
    // Inject routes here...
  };

  const routeMetaData = await Promise.all(
    [
      ...httpRoutes,
      ...wsRoutes,
      ...externalHTTPRoutes,
      ...externalWebSocketRoutes,
    ]
      .filter((r) => r.endsWith('.js'))
      .map(async (routeModule) => {
        const routeImport = `${isWin ? 'file:///' : ''}${routeModule}`;
        const { default: Route } = await import(routeImport);
        if (!Route) {
          throw new Error(`Invalid route file to import docs ${routeModule}`);
        }
        const route = new Route();

        if (disabledRoutes.includes(route.name)) {
          return null;
        }

        const { name } = parse(routeModule);