test: extend external definition tests

test/externalRefs.test.ts

@@ -12,28 +12,68 @@ describe('External $ref', () => {
       silent: true,
     });
 
-    const externalDefinitionSchema = await import(
-      path.resolve(outputPath, 'components/schemas/ExternalDefinition')
+    // $ref: './external-definition.yaml#/components/schemas/Foo1'
+    const externalDefinitionWithRefSchema = await import(
+      path.resolve(outputPath, 'components/schemas/ExternalDefinitionWithRef')
     );
 
-    expect(externalDefinitionSchema.default).toEqual({
-      description: 'External Foo 1 description',
+    expect(externalDefinitionWithRefSchema.default).toEqual({
+      description: 'External Foo description',
       type: ['string', 'null'],
       enum: ['yes', 'no', null],
     });
 
-    const localDefinitionReferencingExternalSchema = await import(
+    // $ref: './external-definition-whole-document.yaml'
+    const externalDefinitionWholeDocumentSchema = await import(
+      path.resolve(
+        outputPath,
+        'components/schemas/ExternalDefinitionWholeDocument',
+      )
+    );
+
+    expect(externalDefinitionWholeDocumentSchema.default).toEqual({
+      description: 'External definition whole document',
+      type: ['string', 'null'],
+      enum: ['yes', 'no', null],
+    });
+
+    // $ref: './external-definition-nested-refs.yaml#/components/schemas/BarFromRef'
+    const externalDefinitionNestedRefsSchema = await import(
+      path.resolve(
+        outputPath,
+        'components/schemas/ExternalDefinitionNestedRefs',
+      )
+    );
+
+    expect(externalDefinitionNestedRefsSchema.default).toEqual({
+      description: 'External Bar description',
+      type: ['string', 'null'],
+      enum: ['yes', 'no', null],
+    });
+
+    // Local definition referencing external schemas
+    const localDefinitionReferencingExternalSchemas = await import(
       path.resolve(
         outputPath,
         'components/schemas/LocalDefinitionReferencingExternal',
       )
     );
 
-    expect(localDefinitionReferencingExternalSchema.default).toEqual({
+    expect(localDefinitionReferencingExternalSchemas.default).toEqual({
       type: 'object',
       properties: {
-        remoteDefinition: {
-          description: 'External Foo 1 description',
+        externalDefinitionWithRef: {
+          description: 'External Foo description',
+          type: ['string', 'null'],
+          enum: ['yes', 'no', null],
+        },
+        externalDefinitionWholeDocument: {
+          description: 'External definition whole document',
+          type: ['string', 'null'],
+          enum: ['yes', 'no', null],
+        },
+        externalDefinitionNestedRefs: {
+          description: 'External Bar description',
           type: ['string', 'null'],
           enum: ['yes', 'no', null],
         },

test/fixtures/external-ref/external-definition-nested-refs.yaml

@@ -0,0 +1,9 @@
+openapi: 3.0.3
+info:
+  title: title
+  description: description
+  version: 1.0.0
+components:
+  schemas:
+    BarFromRef:
+      $ref: './external-definition.yaml#/components/schemas/Bar'

test/fixtures/external-ref/external-definition-whole-document.yaml

@@ -0,0 +1,6 @@
+description: External definition whole document
+type: string
+nullable: true
+enum:
+  - yes
+  - no

test/fixtures/external-ref/external-definition-1.yaml → test/fixtures/external-ref/external-definition.yaml

@@ -5,15 +5,15 @@ info:
   version: 1.0.0
 components:
   schemas:
-    Foo1:
-      description: External Foo 1 description
+    Foo:
+      description: External Foo description
       type: string
       nullable: true
       enum:
         - yes
         - no
-    Bar1:
-      description: External Bar 1 description
+    Bar:
+      description: External Bar description
       type: string
       nullable: true
       enum:

test/fixtures/external-ref/specs.yaml

@@ -8,7 +8,15 @@ components:
     LocalDefinitionReferencingExternal:
       type: object
       properties:
-        remoteDefinition:
-          $ref: '#/components/schemas/ExternalDefinition'
-    ExternalDefinition:
-      $ref: './external-definition-1.yaml#/components/schemas/Foo1'
+        externalDefinitionWithRef:
+          $ref: '#/components/schemas/ExternalDefinitionWithRef'
+        externalDefinitionWholeDocument:
+          $ref: '#/components/schemas/ExternalDefinitionWholeDocument'
+        externalDefinitionNestedRefs:
+          $ref: '#/components/schemas/ExternalDefinitionNestedRefs'
+    ExternalDefinitionWithRef:
+      $ref: './external-definition.yaml#/components/schemas/Foo'
+    ExternalDefinitionWholeDocument:
+      $ref: './external-definition-whole-document.yaml'
+    ExternalDefinitionNestedRefs:
+      $ref: './external-definition-nested-refs.yaml#/components/schemas/BarFromRef'