From 52400c392235fc56ccd53c1e159359e643f5d625 Mon Sep 17 00:00:00 2001
From: Timon Back <timonback@users.noreply.github.com>
Date: Sat, 25 May 2024 23:01:11 +0200
Subject: [PATCH] fix: always allow schema string examples
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: David Müller <david.mueller@codecentric.de>
---
 src/ruleset/v2/functions/schemaValidation.ts  |  2 +-
 .../v2/asyncapi2-schema-examples.spec.ts      | 36 +++++++++----------
 2 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/src/ruleset/v2/functions/schemaValidation.ts b/src/ruleset/v2/functions/schemaValidation.ts
index 845a90005..6e56538b6 100644
--- a/src/ruleset/v2/functions/schemaValidation.ts
+++ b/src/ruleset/v2/functions/schemaValidation.ts
@@ -64,7 +64,7 @@ export const schemaValidation = createRulesetFunction<SchemaFragment, { type: 'd
         },
       );
 
-      if (Array.isArray(result)) {
+      if (Array.isArray(result) && typeof relevantItem.value !== 'string') {
         results.push(...result);
       }
     }
diff --git a/test/ruleset/rules/v2/asyncapi2-schema-examples.spec.ts b/test/ruleset/rules/v2/asyncapi2-schema-examples.spec.ts
index e7bd66fcd..c4edee986 100644
--- a/test/ruleset/rules/v2/asyncapi2-schema-examples.spec.ts
+++ b/test/ruleset/rules/v2/asyncapi2-schema-examples.spec.ts
@@ -43,7 +43,7 @@ testRule('asyncapi2-schema-examples', [
           parameters: {
             userId: {
               schema: {
-                examples: [17, 'one', 13],
+                examples: [17, {}, 13, 'string-is-always-accepted'],
               },
             },
           },
@@ -53,26 +53,26 @@ testRule('asyncapi2-schema-examples', [
         parameters: {
           orphanParameter: {
             schema: {
-              examples: [17, 'one', 13],
+              examples: [17, {}, 13, 'string-is-always-accepted'],
             },
           },
         },
         schemas: {
           aSchema: {
-            type: 'string',
-            examples: [17, 'one', 13],
+            type: 'object',
+            examples: [17, {}, 13, 'string-is-always-accepted'],
           },
         },
       },
     },
     errors: [
       {
-        message: '"0" property type must be string',
+        message: '"0" property type must be object',
         path: ['components', 'schemas', 'aSchema', 'examples', '0'],
         severity: DiagnosticSeverity.Error,
       },
       {
-        message: '"2" property type must be string',
+        message: '"2" property type must be object',
         path: ['components', 'schemas', 'aSchema', 'examples', '2'],
         severity: DiagnosticSeverity.Error,
       },
@@ -88,7 +88,7 @@ testRule('asyncapi2-schema-examples', [
           parameters: {
             userId: {
               schema: {
-                examples: [17, 'one', 13],
+                examples: [17, {}, 13, 'string-is-always-accepted'],
               },
             },
           },
@@ -98,26 +98,26 @@ testRule('asyncapi2-schema-examples', [
         parameters: {
           orphanParameter: {
             schema: {
-              type: 'string',
-              examples: [17, 'one', 13],
+              type: 'object',
+              examples: [17, {}, 13, 'string-is-always-accepted'],
             },
           },
         },
         schemas: {
           aSchema: {
-            examples: [17, 'one', 13],
+            examples: [17, {}, 13, 'string-is-always-accepted'],
           },
         },
       },
     },
     errors: [
       {
-        message: '"0" property type must be string',
+        message: '"0" property type must be object',
         path: ['components', 'parameters', 'orphanParameter', 'schema', 'examples', '0'],
         severity: DiagnosticSeverity.Error,
       },
       {
-        message: '"2" property type must be string',
+        message: '"2" property type must be object',
         path: ['components', 'parameters', 'orphanParameter', 'schema', 'examples', '2'],
         severity: DiagnosticSeverity.Error,
       },
@@ -133,8 +133,8 @@ testRule('asyncapi2-schema-examples', [
           parameters: {
             userId: {
               schema: {
-                type: 'string',
-                examples: [17, 'one', 13],
+                type: 'object',
+                examples: [17, {}, 13, 'string-is-always-accepted'],
               },
             },
           },
@@ -144,25 +144,25 @@ testRule('asyncapi2-schema-examples', [
         parameters: {
           orphanParameter: {
             schema: {
-              examples: [17, 'one', 13],
+              examples: [17, {}, 13, 'string-is-always-accepted'],
             },
           },
         },
         schemas: {
           aSchema: {
-            examples: [17, 'one', 13],
+            examples: [17, {}, 13, 'string-is-always-accepted'],
           },
         },
       },
     },
     errors: [
       {
-        message: '"0" property type must be string',
+        message: '"0" property type must be object',
         path: ['channels', 'users/{userId}/signedUp', 'parameters', 'userId', 'schema', 'examples', '0'],
         severity: DiagnosticSeverity.Error,
       },
       {
-        message: '"2" property type must be string',
+        message: '"2" property type must be object',
         path: ['channels', 'users/{userId}/signedUp', 'parameters', 'userId', 'schema', 'examples', '2'],
         severity: DiagnosticSeverity.Error,
       },