fix: false positive errors when validating examples with refs (#1377)

.changeset/small-rules-vanish.md

@@ -0,0 +1,6 @@
+---
+"@redocly/openapi-core": patch
+"@redocly/cli": patch
+---
+
+Fixed a problem where the linter incorrectly returned an error for valid examples that contain references.

__tests__/lint/no-invalid-media-type-examples-multiple-valid-refs-different-files/components.yaml

@@ -0,0 +1,11 @@
+components:
+  schemas:
+    A:
+      type: object
+      properties:
+        a:
+          type: string
+        b:
+          $ref: '#/components/schemas/B'
+    B:
+      type: string

__tests__/lint/no-invalid-media-type-examples-multiple-valid-refs-different-files/openapi.yaml

@@ -0,0 +1,21 @@
+openapi: 3.1.0
+components:
+  schemas:
+    C:
+      $ref: './components.yaml#/components/schemas/A'
+    D:
+      $ref: './components.yaml#/components/schemas/A'
+paths:
+  /pet:
+    get:
+      responses:
+        200:
+          content:
+            application/json:
+              example: { 'a': 'test', 'b': 'test' }
+              schema:
+                $ref: '#/components/schemas/C'
+            application/x+json:
+              example: { 'a': 'test', 'b': 'test' }
+              schema:
+                $ref: '#/components/schemas/D'

__tests__/lint/no-invalid-media-type-examples-multiple-valid-refs-different-files/redocly.yaml

@@ -0,0 +1,6 @@
+apis:
+  main:
+    root: ./openapi.yaml
+
+rules:
+  no-invalid-media-type-examples: error

__tests__/lint/no-invalid-media-type-examples-multiple-valid-refs-different-files/snapshot.js

@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`E2E lint no-invalid-media-type-examples-multiple-valid-refs-different-files 1`] = `
+
+validating /openapi.yaml...
+/openapi.yaml: validated in <test>ms
+
+Woohoo! Your API description is valid. 🎉
+
+
+`;

__tests__/lint/no-invalid-media-type-examples-multiple-valid-refs/openapi.yaml

@@ -0,0 +1,53 @@
+openapi: 3.1.0
+paths:
+  /foo:
+    get:
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    $ref: '#/components/schemas/foo'
+              examples:
+                ValidFoo:
+                  value:
+                    id: 1
+  /bar:
+    get:
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    $ref: '#/components/schemas/bar'
+              examples:
+                ValidBar:
+                  value:
+                    id: 1
+            application/baz+json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    $ref: '#/components/schemas/baz'
+              examples:
+                ValidBaz:
+                  value: #
+                    id: 3
+
+components:
+  schemas:
+    commonId:
+      type: integer
+    foo:
+      $ref: '#/components/schemas/commonId'
+    bar:
+      $ref: '#/components/schemas/commonId'
+    baz:
+      $ref: '#/components/schemas/commonId'

__tests__/lint/no-invalid-media-type-examples-multiple-valid-refs/redocly.yaml

@@ -0,0 +1,6 @@
+apis:
+  main:
+    root: ./openapi.yaml
+
+rules:
+  no-invalid-media-type-examples: error

__tests__/lint/no-invalid-media-type-examples-multiple-valid-refs/snapshot.js

@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`E2E lint no-invalid-media-type-examples-multiple-valid-refs 1`] = `
+
+validating /openapi.yaml...
+/openapi.yaml: validated in <test>ms
+
+Woohoo! Your API description is valid. 🎉
+
+
+`;

packages/core/src/rules/ajv.ts

@@ -1,6 +1,8 @@
-import Ajv, { ValidateFunction, ErrorObject } from '@redocly/ajv/dist/2020';
+import Ajv from '@redocly/ajv/dist/2020';
 import { Location, escapePointer } from '../ref-utils';
-import { ResolveFn } from '../walk';
+
+import type { ValidateFunction, ErrorObject } from '@redocly/ajv/dist/2020';
+import type { ResolveFn } from '../walk';
 
 let ajvInstance: Ajv | null = null;
 
@@ -21,10 +23,10 @@ function getAjv(resolve: ResolveFn, allowAdditionalProperties: boolean) {
       allowUnionTypes: true,
       validateFormats: false, // TODO: fix it
       defaultUnevaluatedProperties: allowAdditionalProperties,
-      loadSchemaSync(base: string, $ref: string) {
+      loadSchemaSync(base: string, $ref: string, $id: string) {
         const resolvedRef = resolve({ $ref }, base.split('#')[0]);
         if (!resolvedRef || !resolvedRef.location) return false;
-        return { $id: resolvedRef.location.absolutePointer, ...resolvedRef.node };
+        return { $id: resolvedRef.location.source.absoluteRef + '#' + $id, ...resolvedRef.node };
       },
       logger: false,
     });