fix: error can't resolve $ref when components.parameters has a ref to the components.schemas

.changeset/happy-chairs-drop.md

@@ -0,0 +1,5 @@
+---
+"@redocly/openapi-core": patch
+---
+
+Fixed an issue where the `remove-unused-components` decorator was failing to resolve `$ref` references to schemas from `components`.

docs/@v2/commands/bundle.md

@@ -10,7 +10,7 @@ Redocly CLI can help you combine separate API description files (such as if you
 The `bundle` command pulls the relevant parts of an API description into a single file output in JSON or YAML format.
 
 The `bundle` command differs from the [`join`](./join.md) command.
-The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file.
+The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. All components are automatically resolved and included without requiring explicit definitions.
 The `join` command can combine multiple OpenAPI files into a single unified API description file.
 
 The `bundle` command first executes preprocessors, then rules, then decorators.

packages/core/src/bundle/bundle-visitor.ts

@@ -126,7 +126,8 @@ export function makeBundleVisitor(
             replaceRef(node, resolved, ctx);
           } else {
             node.$ref = saveComponent(componentType, resolved, ctx);
-            resolveBundledComponent(node, resolved, ctx);
+            // Register the bundled component from the original location
+            resolveBundledComponent(node, resolved);
           }
         }
       },
@@ -186,8 +187,8 @@ export function makeBundleVisitor(
     };
   }
 
-  function resolveBundledComponent(node: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
-    const newRefId = makeRefId(ctx.location.source.absoluteRef, node.$ref);
+  function resolveBundledComponent(node: OasRef, resolved: ResolveResult<any>) {
+    const newRefId = makeRefId(rootDocument.source.absoluteRef, node.$ref);
     resolvedRefMap.set(newRefId, {
       document: rootDocument,
       isRemote: false,

packages/core/src/walk.ts

@@ -395,7 +395,7 @@ export function walkDocument<T extends BaseVisitor>(opts: {
             node,
             {
               report,
-              resolve,
+              resolve: (ref, from = document.source.absoluteRef) => resolve(ref, from),
               rawNode: node,
               rawLocation,
               location,

tests/e2e/bundle/parameters-reference-to-schemas/openapi.yaml

@@ -0,0 +1,17 @@
+openapi: 3.0.0
+info:
+  title: Sample API
+  version: 1.0.0
+paths:
+  /users:
+    get:
+      operationId: getUsers
+      summary: Get a list of users
+      parameters:
+        - $ref: parameters.yaml#/Param
+      responses:
+        '200':
+          description: A list of users
+          content:
+            application/json:
+              schema: {}

tests/e2e/bundle/parameters-reference-to-schemas/parameters.yaml

@@ -0,0 +1,6 @@
+Param:
+  name: param
+  in: query
+  required: true
+  schema:
+    $ref: schemas.yaml#/Schema

tests/e2e/bundle/parameters-reference-to-schemas/redocly.yaml

@@ -0,0 +1,6 @@
+apis:
+  test-api:
+    root: openapi.yaml
+
+decorators:
+  remove-unused-components: on

tests/e2e/bundle/parameters-reference-to-schemas/schemas.yaml

@@ -0,0 +1,2 @@
+Schema:
+  type: string

tests/e2e/bundle/parameters-reference-to-schemas/snapshot.txt

@@ -0,0 +1,31 @@
+openapi: 3.0.0
+info:
+  title: Sample API
+  version: 1.0.0
+paths:
+  /users:
+    get:
+      operationId: getUsers
+      summary: Get a list of users
+      parameters:
+        - $ref: '#/components/parameters/Param'
+      responses:
+        '200':
+          description: A list of users
+          content:
+            application/json:
+              schema: {}
+components:
+  schemas:
+    Schema:
+      type: string
+  parameters:
+    Param:
+      name: param
+      in: query
+      required: true
+      schema:
+        $ref: '#/components/schemas/Schema'
+
+bundling openapi.yaml using configuration for api 'test-api'...
+📦 Created a bundle for openapi.yaml at stdout <test>ms.

tests/e2e/commands.test.ts

@@ -672,6 +672,16 @@ describe('E2E', () => {
     });
   });
 
+  describe('bundle with parameter, which has reference to schemas', () => {
+    it('should correctly bundle the api and not remove components', async () => {
+      const testPath = join(__dirname, `bundle/parameters-reference-to-schemas`);
+      const args = getParams(indexEntryPoint, ['bundle', '--config=redocly.yaml']);
+
+      const result = getCommandOutput(args, { testPath });
+      await expect(cleanupOutput(result)).toMatchFileSnapshot(join(testPath, 'snapshot.txt'));
+    });
+  });
+
   describe('miscellaneous', () => {
     const folderPath = join(__dirname, 'miscellaneous');