feat: add openapi gen to core

packages/core-tools/package.json

@@ -103,7 +103,6 @@
     ]
   },
   "eslintIgnore": [
-    "resources",
-    "openapi"
+    "resources"
   ]
 }

packages/core-tools/src/app.ts

@@ -15,7 +15,6 @@
 import {Logger} from '@openstapps/logger';
 import {Command} from 'commander';
 import {existsSync, readFileSync, writeFileSync} from 'fs';
-import {copy} from 'fs-extra';
 import path from 'path';
 import {lightweightDefinitionsFromPath, lightweightProjectFromPath} from '@openstapps/easy-ast';
 import {openapi3Template} from './resources/openapi-303-template.js';
@@ -57,7 +56,7 @@ commander
     // get absolute paths
     const sourcePath = path.resolve(relativeSourceBundlePath);
     const outDirectoryPath = path.resolve(relativeOutDirectoryPath);
-    const outDirectorySchemasPath = path.join(outDirectoryPath, 'schemas');
+    const outDirectorySchemasPath = path.join(outDirectoryPath, 'schema');
 
     // get information about routes
     const routes = await gatherRouteInformation(sourcePath);
@@ -82,9 +81,6 @@ commander
     // initialize json output
     const output = openapi3Template;
 
-    // names of the schemas to copy
-    const schemasToCopy: string[] = [];
-
     // generate documentation for all routes
     for (const routeWithMetaInformation of routes) {
       routeWithMetaInformation.tags = [capitalize(routeWithMetaInformation.route.urlPath.split('/')[1])];
@@ -92,29 +88,10 @@ commander
       output.paths[routeWithMetaInformation.route.urlPath] = generateOpenAPIForRoute(
         routeWithMetaInformation,
         path.relative(relativeOutDirectoryPath, outDirectorySchemasPath),
-        schemasToCopy,
         tagsToKeep,
       );
     }
 
-    // copy schema json schema files
-    try {
-      if (!existsSync(outDirectorySchemasPath)) {
-        await mkdir(outDirectorySchemasPath, {
-          recursive: true,
-        });
-      }
-      for (const fileName of schemasToCopy) {
-        await copy(
-          path.join(sourcePath, 'schema', `${fileName}.json`),
-          path.join(outDirectorySchemasPath, `${fileName}.json`),
-        );
-      }
-    } catch (error) {
-      await Logger.error(error);
-      process.exit(-2);
-    }
-
     // write openapi object to file (prettified)
     writeFileSync(path.join(outDirectoryPath, 'openapi.json'), JSON.stringify(output, undefined, 2));
 

packages/core-tools/src/routes.ts

@@ -79,20 +79,16 @@ export async function gatherRouteInformation(path: string): Promise<RouteWithMet
  * Generate documentation snippet for one route
  * @param routeWithInfo A route instance with its meta information
  * @param outDirectorySchemasPath Path to directory that will contain relevant schemas for the route
- * @param schemasToCopy Schemas identified as relevant for this route
  * @param tagsToKeep Tags / keywords that can be used for grouping routes
  */
 export function generateOpenAPIForRoute(
   routeWithInfo: RouteWithMetaInformation,
   outDirectorySchemasPath: string,
-  schemasToCopy: string[],
   tagsToKeep: string[],
 ): OpenAPIV3.PathItemObject {
   const route = routeWithInfo.route;
   const openapiPath: OpenAPIV3.PathItemObject = {};
 
-  schemasToCopy.push(route.requestBodyName, route.responseBodyName);
-
   openapiPath[route.method.toLowerCase() as OpenAPIV3.HttpMethods] = {
     summary: capitalize(routeWithInfo.description.shortText?.replace(/(Route to |Route for )/gim, '')),
     description: routeWithInfo.description.text,
@@ -133,7 +129,6 @@ export function generateOpenAPIForRoute(
   };
 
   for (const error of route.errors) {
-    schemasToCopy.push(error.name);
     openapiPath[route.method.toLowerCase() as OpenAPIV3.HttpMethods]!.responses![error.statusCode] = {
       description:
         error.message ?? capitalize(error.name.replaceAll(/([A-Z][a-z])/g, ' $1').replace('SC ', '')),
@@ -155,7 +150,7 @@ export function generateOpenAPIForRoute(
         required: true,
         schema: {
           // TODO make this less of a hack and search copied schemas for the first occurring definition
-          $ref: `schemas/SCSearchResponse.json#/definitions/${schemaDefinition}`,
+          $ref: `schema/SCSearchResponse.json#/definitions/${schemaDefinition}`,
         },
       };
       openapiPath[route.method.toLowerCase() as OpenAPIV3.HttpMethods]?.parameters?.push(openapiParameter);