Allow swagger docs that dont have defined schema refs. Right now whol…

…e app crashes if a schema is missing a $ref
ardatan · Jan 27, 2022 · 7940d1f · 7940d1f
1 parent 177f9fb
commit 7940d1f
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/packages/handlers/openapi/src/openapi-to-graphql/oas_3_tools.ts b/packages/handlers/openapi/src/openapi-to-graphql/oas_3_tools.ts
@@ -629,9 +629,21 @@ export function getResponseSchemaAndNames<TSource, TContext, TArgs>(
     );
     let responseSchema = responseObject.content[availableSimilarContentType || contentTypes[0]].schema;
     let fromRef: string;
-    if ('$ref' in responseSchema) {
-      fromRef = responseSchema.$ref.split('/').pop();
-      responseSchema = resolveRef(responseSchema.$ref, oas);
+
+    if (responseSchema) {
+      if ('$ref' in responseSchema) {
+        fromRef = responseSchema.$ref.split('/').pop();
+        responseSchema = resolveRef(responseSchema.$ref, oas);
+      }
+    } else if (options.allowUndefinedSchemaRefTags) {
+      options.logger.info(`${path}:${method.toUpperCase()}:${statusCode}`);
+      fromRef = 'Unknown';
+      responseSchema = {
+        description: `Placeholder for missing ${path}:${method.toUpperCase()}:${statusCode} schema ref`,
+        type: options.defaultUndefinedSchemaType || 'object',
+      };
+    } else {
+      throw new Error(`${path}:${method.toUpperCase()}:${statusCode} has an undefined schema ref`);
     }
 
     const responseSchemaNames = {

diff --git a/packages/handlers/openapi/src/openapi-to-graphql/types/options.ts b/packages/handlers/openapi/src/openapi-to-graphql/types/options.ts
@@ -300,4 +300,14 @@ export type InternalOptions<TSource, TContext, TArgs> = {
   includeHttpDetails?: boolean;
   pubsub: MeshPubSub;
   logger: Logger;
+
+  /**
+   * Allow processing to continue if the swagger schema is missing a schema $ref.
+   */
+  allowUndefinedSchemaRefTags?: boolean;
+
+  /**
+   * Object type to use for missing swagger schemas refs default is object.
+   */
+  defaultUndefinedSchemaType?: 'string' | 'number' | 'object' | 'array' | 'boolean' | 'integer';
 };