fix: error with invalid type when using exclusiveMininimum and exclusiveMaximum in oas3

Author: AlbinaBlazhko17

.changeset/afraid-streets-like.md

@@ -0,0 +1,5 @@
+---
+"@redocly/openapi-core": patch
+---
+
+Fixed an issue where the `no-invalid-schema-examples` rule was incorrectly linting the `exclusiveMinimum` and `exclusiveMaximum` properties in OpenAPI 3.0.

__tests__/lint/no-invalid-media-type-examples-exclusive-minimum/openapi.yaml

@@ -0,0 +1,43 @@
+openapi: 3.0.2
+info:
+  title: Example OpenAPI 3 definition.
+  version: 1.0.0
+
+paths:
+  /pet:
+    get:
+      parameters:
+        - $ref: '#/components/parameters/validExample'
+      responses:
+        '200':
+          description: Response description
+          content:
+            application/json:
+              schema: {}
+
+components:
+  parameters:
+    validExample:
+      in: header
+      name: Test
+      schema:
+        type: integer
+        minimum: 10
+        exclusiveMinimum: true
+        example: 11
+    notValidExampleWithExclusiveMaximum:
+      in: query
+      name: anotherTest
+      schema:
+        type: integer
+        minimum: 5
+        exclusiveMaximum: true
+        example: 10
+    notValidExample:
+      in: query
+      name: yetAnotherTest
+      schema:
+        type: integer
+        minimum: 0
+        exclusiveMinimum: true
+        example: 0

__tests__/lint/no-invalid-media-type-examples-exclusive-minimum/redocly.yaml

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

__tests__/lint/no-invalid-media-type-examples-exclusive-minimum/snapshot.txt

@@ -0,0 +1,44 @@
+[1] openapi.yaml:32:9 at #/components/parameters/notValidExampleWithExclusiveMaximum/schema/schema
+
+Example validation errored: exclusiveMaximum can only be used with maximum.
+
+30 |   name: anotherTest
+31 |   schema:
+32 |     type: integer
+   |     ^^^^^^^^^^^^^
+33 |     minimum: 5
+   |     ^^^^^^^^^^
+34 |     exclusiveMaximum: true
+   |     ^^^^^^^^^^^^^^^^^^^^^^
+35 |     example: 10
+   |     ^^^^^^^^^^^
+36 | notValidExample:
+37 |   in: query
+
+referenced from openapi.yaml:32:9 at #/components/parameters/notValidExampleWithExclusiveMaximum/schema 
+
+Error was generated by the no-invalid-schema-examples rule.
+
+
+[2] openapi.yaml:43:18 at #/components/parameters/notValidExample/schema/example
+
+Example value must conform to the schema: must be > 0.
+
+41 | minimum: 0
+42 | exclusiveMinimum: true
+43 | example: 0
+   |          ^
+44 |
+
+referenced from openapi.yaml:40:9 at #/components/parameters/notValidExample/schema 
+
+Error was generated by the no-invalid-schema-examples rule.
+
+
+
+validating openapi.yaml using lint rules for api 'main'...
+openapi.yaml: validated in <test>ms
+
+❌ Validation failed with 2 errors.
+run `redocly lint --generate-ignore-file` to add all problems to the ignore file.
+

package-lock.json

@@ -54,6 +54,7 @@
   "dependencies": {
     "@redocly/ajv": "^8.11.2",
     "@redocly/config": "^0.31.0",
+    "ajv-draft-04": "^1.0.0",
     "ajv-formats": "^2.1.1",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",

packages/core/package.json

@@ -1,12 +1,13 @@
 import addFormats from 'ajv-formats';
 import Ajv from '@redocly/ajv/dist/2020.js';
+import AjvDraft04 from 'ajv-draft-04';
 import { escapePointer } from '../ref-utils.js';
 
 import type { Location } from '../ref-utils.js';
 import type { ValidateFunction, ErrorObject } from '@redocly/ajv/dist/2020.js';
 import type { ResolveFn } from '../walk.js';
 
-let ajvInstance: Ajv | null = null;
+let ajvInstance: Ajv | AjvDraft04 | null = null;
 
 export function releaseAjvInstance() {
   ajvInstance = null;
@@ -37,6 +38,26 @@ function getAjv(resolve: ResolveFn, allowAdditionalProperties: boolean) {
   return ajvInstance;
 }
 
+function getAjvDraft04(): AjvDraft04 {
+  if (!ajvInstance) {
+    ajvInstance = new AjvDraft04({
+      schemaId: 'id',
+      meta: false,
+      allErrors: true,
+      strictSchema: false,
+      inlineRefs: true,
+      validateSchema: false,
+      discriminator: true,
+      allowUnionTypes: true,
+      validateFormats: true,
+      logger: false,
+    });
+    addFormats(ajvInstance);
+  }
+
+  return ajvInstance as AjvDraft04;
+}
+
 function getAjvValidator(
   schema: any,
   loc: Location,
@@ -52,15 +73,36 @@ function getAjvValidator(
   return ajv.getSchema(loc.absolutePointer);
 }
 
+function getAjvDraft04Validator(
+  schema: any,
+  loc: Location,
+  resolve: ResolveFn
+): ValidateFunction | undefined {
+  const ajv = getAjvDraft04();
+
+  if (!ajv.getSchema(loc.absolutePointer)) {
+    // Dereference the schema to resolve all $refs before adding to Ajv
+    const dereferencedSchema = dereferenceSchema(schema, loc.source.absoluteRef, resolve);
+
+    ajv.addSchema(dereferencedSchema, loc.absolutePointer);
+  }
+
+  return ajv.getSchema(loc.absolutePointer);
+}
+
 export function validateJsonSchema(
   data: any,
   schema: any,
   schemaLoc: Location,
   instancePath: string,
   resolve: ResolveFn,
-  allowAdditionalProperties: boolean
+  allowAdditionalProperties: boolean,
+  specVersion: string = 'oas3_1'
 ): { valid: boolean; errors: (ErrorObject & { suggest?: string[] })[] } {
-  const validate = getAjvValidator(schema, schemaLoc, resolve, allowAdditionalProperties);
+  const validate =
+    specVersion === 'oas3_1'
+      ? getAjvValidator(schema, schemaLoc, resolve, allowAdditionalProperties)
+      : getAjvDraft04Validator(schema, schemaLoc, resolve);
   if (!validate) return { valid: true, errors: [] }; // unresolved refs are reported
 
   const valid = validate(data, {
@@ -105,3 +147,42 @@ export function validateJsonSchema(
     };
   }
 }
+
+function dereferenceSchema(
+  schema: any,
+  baseRef: string,
+  resolve: ResolveFn,
+  visited: WeakSet<any> = new WeakSet()
+): any {
+  if (!schema || typeof schema !== 'object') {
+    return schema;
+  }
+
+  if (visited.has(schema)) {
+    return schema;
+  }
+  visited.add(schema);
+
+  if (Array.isArray(schema)) {
+    return schema.map((item) => dereferenceSchema(item, baseRef, resolve, visited));
+  }
+
+  if (schema.$ref) {
+    const resolved = resolve({ $ref: schema.$ref });
+    if (resolved && resolved.node) {
+      return dereferenceSchema(
+        resolved.node,
+        resolved.location.source.absoluteRef,
+        resolve,
+        visited
+      );
+    }
+    return schema;
+  }
+
+  const result: any = {};
+  for (const [key, value] of Object.entries(schema)) {
+    result[key] = dereferenceSchema(value, baseRef, resolve, visited);
+  }
+  return result;
+}

packages/core/src/rules/ajv.ts

@@ -31,7 +31,14 @@ export const NoInvalidSchemaExamples: Oas3Rule | Oas2Rule = (opts: any) => {
             return;
           }
 
-          validateExample(schema.example, schema, ctx.location.child('example'), ctx, true);
+          validateExample(
+            schema.example,
+            schema,
+            ctx.location.child('example'),
+            ctx,
+            true,
+            ctx.specVersion
+          );
         }
       },
     },

packages/core/src/rules/common/no-invalid-schema-examples.ts

@@ -134,7 +134,8 @@ export function validateExample(
   schema: Referenced<Oas3Schema | Oas3_1Schema>,
   dataLoc: Location,
   { resolve, location, report }: UserContext,
-  allowAdditionalProperties: boolean
+  allowAdditionalProperties: boolean,
+  specVersion?: string
 ) {
   try {
     const { valid, errors } = validateJsonSchema(
@@ -143,7 +144,8 @@ export function validateExample(
       location.child('schema'),
       dataLoc.pointer,
       resolve,
-      allowAdditionalProperties
+      allowAdditionalProperties,
+      specVersion
     );
     if (!valid) {
       for (const error of errors) {