fix(resolver): align resolver strategies behavior

Refs #3728
swagger-api · Jan 3, 2025 · e5b9f33 · e5b9f33
1 parent 36b6537
commit e5b9f33
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 3 deletions.
diff --git a/src/index.js b/src/index.js
@@ -120,6 +120,7 @@ Swagger.prototype = {
       useCircularStructures: this.useCircularStructures,
       requestInterceptor: this.requestInterceptor || null,
       responseInterceptor: this.responseInterceptor || null,
+      pathDiscriminator: this.pathDiscriminator || [],
       skipNormalization: this.skipNormalization || false,
       ...options,
     }).then((obj) => {

diff --git a/src/resolver/strategies/openapi-3-1-apidom/resolve.js b/src/resolver/strategies/openapi-3-1-apidom/resolve.js
@@ -161,7 +161,7 @@ const resolveOpenAPI31Strategy = async (options) => {
     return { spec: toValue(normalized), errors };
   } catch (error) {
     if (error instanceof InvalidJsonPointerError || error instanceof EvaluationJsonPointerError) {
-      return { spec: null, errors: [] };
+      return { spec, errors: [] };
     }
     throw error;
   }

diff --git a/test/index.js b/test/index.js
@@ -60,6 +60,27 @@ describe('constructor', () => {
       });
     });
 
+    test('should accept pathDiscriminator', async () => {
+      const spec = {
+        one: {
+          $ref: '#/two',
+        },
+        two: {
+          hi: 'hello',
+        },
+      };
+      const client = await SwaggerClient({ spec, pathDiscriminator: ['two'] });
+
+      expect(client.spec).toEqual({
+        one: {
+          $ref: '#/two',
+        },
+        two: {
+          hi: 'hello',
+        },
+      });
+    });
+
     test('should resolve a cyclic spec when baseDoc is specified', async () => {
       const spec = {
         paths: {

diff --git a/test/resolver/strategies/generic/index.js b/test/resolver/strategies/generic/index.js
@@ -48,6 +48,30 @@ describe('resolver', () => {
     });
   });
 
+  test('should resolve nothing when invalid pathDiscriminator supplied', async () => {
+    const spec = {
+      openapi: '3.0.4',
+      components: {
+        schemas: {
+          one: { type: 'string' },
+          two: { $ref: '#/components/schemas/one' },
+        },
+      },
+    };
+    const result = await Swagger.resolve({ spec, pathDiscriminator: ['info1'] });
+
+    expect(result.errors).toEqual([]);
+    expect(result.spec).toEqual({
+      openapi: '3.0.4',
+      components: {
+        schemas: {
+          one: { type: 'string' },
+          two: { $ref: '#/components/schemas/one' },
+        },
+      },
+    });
+  });
+
   test('should resolve OpenAPI 3.0.0 Description', async () => {
     const spec = {
       openapi: '3.0.0',

diff --git a/test/resolver/strategies/openapi-3-1-apidom/index.js b/test/resolver/strategies/openapi-3-1-apidom/index.js
@@ -205,14 +205,14 @@ describe('resolve', () => {
       });
 
       describe('and pathDiscriminator compiles into invalid JSON Pointer', () => {
-        test('should return spec as null', async () => {
+        test('should not resole', async () => {
           const spec = globalThis.loadJsonFile(path.join(fixturePath, 'petstore.json'));
           const resolvedSpec = await SwaggerClient.resolve({
             spec,
             pathDiscriminator: ['path', 'to', 'nothing'],
           });
 
-          expect(resolvedSpec).toEqual({ spec: null, errors: [] });
+          expect(resolvedSpec).toEqual({ spec, errors: [] });
         });
       });