fix(rulesets): always allow string examples in asyncapi schema (#2625)

Co-authored-by: David Müller <[email protected]>
Co-authored-by: Nauman <[email protected]>
Co-authored-by: Jonas Lagoni <[email protected]>

Author: 4 people

packages/rulesets/src/asyncapi/functions/__tests__/asyncApi2SchemaValidation.test.ts

@@ -7,19 +7,19 @@ function runPayloadValidation(targetVal: any, opts: { type: 'examples' | 'defaul
 describe('asyncApi2SchemaValidation', () => {
   test('validates examples', () => {
     const payload = {
-      type: 'string',
-      examples: [17, 'one', 13],
+      type: 'object',
+      examples: [17, {}, 13, 'string-is-always-accepted'],
     };
 
     const results = runPayloadValidation(payload, { type: 'examples' });
 
     expect(results).toEqual([
       {
-        message: '"0" property type must be string',
+        message: '"0" property type must be object',
         path: ['examples', 0],
       },
       {
-        message: '"2" property type must be string',
+        message: '"2" property type must be object',
         path: ['examples', 2],
       },
     ]);

packages/rulesets/src/asyncapi/functions/asyncApi2SchemaValidation.ts

@@ -67,7 +67,7 @@ export default createRulesetFunction<SchemaFragment, Options>(
         },
       );
 
-      if (Array.isArray(result)) {
+      if (Array.isArray(result) && typeof relevantItem.value !== 'string') {
         results.push(...result);
       }
     }