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

…e app crashes if a schema is missing a $ref (#3551)

.changeset/spotty-avocados-walk.md

@@ -0,0 +1,18 @@
+---
+"@graphql-mesh/openapi": minor
+---
+
+Allow swagger docs that don't have defined schema refs. Right now whole app crashes if a schema is missing a $ref;
+
+
+```ts
+  /**
+   * 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';
+```

packages/handlers/openapi/src/index.ts

@@ -201,6 +201,8 @@ export default class OpenAPIHandler implements MeshHandler {
 
         return originalFactory(() => resolverParams, this.logger)(root, args, context, info);
       },
+      allowUndefinedSchemaRefTags: this.config.allowUndefinedSchemaRefTags,
+      defaultUndefinedSchemaType: this.config.defaultUndefinedSchemaType,
     });
 
     const { args, contextVariables } = parseInterpolationStrings(Object.values(operationHeaders || {}));

packages/handlers/openapi/src/openapi-to-graphql/oas_3_tools.ts

@@ -635,9 +635,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 = {

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';
 };

packages/handlers/openapi/yaml-config.graphql

@@ -57,6 +57,14 @@ type OpenapiHandler @md {
   This option forces OpenAPI handler to only create field names based on the operationId.
   """
   operationIdFieldNames: Boolean
+  """
+  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: UndefinedSchemaType
 }
 
 enum SourceFormat {
@@ -87,3 +95,12 @@ enum QueryOrMutation {
   Query
   Mutation
 }
+
+enum UndefinedSchemaType {
+  string
+  number
+  object
+  array
+  boolean
+  integer
+}

packages/types/src/config-schema.json

@@ -1995,6 +1995,15 @@
         "operationIdFieldNames": {
           "type": "boolean",
           "description": "Field names can only be sanitized operationIds\nBy default, query field names are based on the return type type name and mutation field names are based on the operationId, which may be generated if it does not exist.\nThis option forces OpenAPI handler to only create field names based on the operationId."
+        },
+        "allowUndefinedSchemaRefTags": {
+          "type": "boolean",
+          "description": "Allow processing to continue if the swagger schema is missing a schema $ref."
+        },
+        "defaultUndefinedSchemaType": {
+          "type": "string",
+          "enum": ["string", "number", "object", "array", "boolean", "integer"],
+          "description": "Object type to use for missing swagger schemas refs default is object. (Allowed values: string, number, object, array, boolean, integer)"
         }
       },
       "required": ["source"]

packages/types/src/config.ts

@@ -921,6 +921,14 @@ export interface OpenapiHandler {
    * This option forces OpenAPI handler to only create field names based on the operationId.
    */
   operationIdFieldNames?: boolean;
+  /**
+   * 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. (Allowed values: string, number, object, array, boolean, integer)
+   */
+  defaultUndefinedSchemaType?: 'string' | 'number' | 'object' | 'array' | 'boolean' | 'integer';
 }
 export interface SelectQueryOrMutationFieldConfig {
   /**

website/src/generated-markdown/OpenapiHandler.generated.md

@@ -17,4 +17,6 @@ Overrides the server object in the OAS.
 * `provideErrorExtensions` (type: `Boolean`) - Overwrite automatic wrapping of errors into GraphqlErrors
 * `operationIdFieldNames` (type: `Boolean`) - Field names can only be sanitized operationIds
 By default, query field names are based on the return type type name and mutation field names are based on the operationId, which may be generated if it does not exist.
-This option forces OpenAPI handler to only create field names based on the operationId.
+This option forces OpenAPI handler to only create field names based on the operationId.
+* `allowUndefinedSchemaRefTags` (type: `Boolean`) - Allow processing to continue if the swagger schema is missing a schema $ref.
+* `defaultUndefinedSchemaType` (type: `String (string | number | object | array | boolean | integer)`) - Object type to use for missing swagger schemas refs default is object.