fix: overide behaviour of fixing externalValue without modifying

Redocly · Oct 3, 2024 · 42ad933 · 42ad933
1 parent 5f52ff9
commit 42ad933
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 10 deletions.
diff --git a/.changeset/little-pears-sniff.md b/.changeset/little-pears-sniff.md
@@ -3,4 +3,4 @@
 "@redocly/cli": patch
 ---
 
-Fixed an issue where the bundle command did not resolve relative links in `externalValue`.
+Fixed an issue where the bundle command did not resolve links in `externalValue`.
diff --git a/packages/core/src/bundle.ts b/packages/core/src/bundle.ts
@@ -379,6 +379,14 @@ function makeBundleVisitor(
         }
       },
     },
+    Example: {
+      leave(node: any, ctx: UserContext, resolved: any) {
+        if (node.externalValue && node.value === undefined) {
+          node.value = ctx.resolve({ $ref: node.externalValue }).node;
+          delete node.externalValue;
+        }
+      },
+    },
     Root: {
       enter(root: any, ctx: any) {
         rootLocation = ctx.location;

diff --git a/packages/core/src/resolve.ts b/packages/core/src/resolve.ts
@@ -289,14 +289,6 @@ export async function resolveDocument(opts: {
         return;
       }
 
-      // handle externalValue with relative reference in examples object
-      if (node.externalValue) {
-        node.value = {
-          $ref: node.externalValue,
-        };
-        delete node.externalValue;
-      }
-
       for (const propName of Object.keys(node)) {
         let propValue = node[propName];
         let propType = type.properties[propName];
@@ -343,6 +335,28 @@ export async function resolveDocument(opts: {
         });
         resolvePromises.push(promise);
       }
+
+      // handle externalValue with relative reference in examples object
+      if (node.externalValue) {
+        const promise = followRef(
+          rootNodeDocument,
+          { $ref: node.externalValue },
+          {
+            prev: null,
+            node,
+          }
+        ).then((resolvedRef) => {
+          if (resolvedRef.resolved) {
+            resolveRefsInParallel(
+              resolvedRef.node,
+              resolvedRef.document,
+              resolvedRef.nodePointer!,
+              type
+            );
+          }
+        });
+        resolvePromises.push(promise);
+      }
     }
 
     async function followRef(

diff --git a/packages/core/src/rules/oas3/__tests__/fixtures/external-value.yaml b/packages/core/src/rules/oas3/__tests__/fixtures/external-value.yaml
@@ -0,0 +1,2 @@
+a: foo
+b: 100
diff --git a/packages/core/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts b/packages/core/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts
@@ -553,7 +553,7 @@ describe('no-invalid-media-type-examples', () => {
                             type: number
                       examples:
                         first:
-                          externalValue: "https://example.com/example.json"
+                          externalValue: ./fixtures/external-value.yaml
       `,
       'foobar.yaml'
     );