@redocly/openapi-core 1.3.0 → 1.4.0

package/src/rules/__tests__/no-unresolved-refs.test.ts

@@ -27,10 +27,10 @@ describe('oas3 boolean-parameter-prefixes', () => {
     });
 
     expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1test/put/requestBody",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -39,7 +39,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
           "message": "Can't resolve $ref: ENOENT: no such file or directory 'invalid.yaml'",
           "ruleId": "no-unresolved-refs",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -67,36 +67,36 @@ describe('oas3 boolean-parameter-prefixes', () => {
     });
 
     expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": undefined,
               "reportOnKey": false,
               "source": "fixtures/invalid-yaml.yaml",
-              "start": Object {
+              "start": {
                 "col": 1,
                 "line": 2,
               },
             },
           ],
-          "message": "Failed to parse: unexpected end of the stream within a single quoted scalar in \\"fixtures/invalid-yaml.yaml\\" (2:1)",
+          "message": "Failed to parse: unexpected end of the stream within a single quoted scalar in "fixtures/invalid-yaml.yaml" (2:1)",
           "ruleId": "no-unresolved-refs",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1test/put/requestBody",
               "reportOnKey": false,
               "source": "foobar.yaml",
             },
           ],
-          "message": "Can't resolve $ref: unexpected end of the stream within a single quoted scalar in \\"fixtures/invalid-yaml.yaml\\" (2:1)",
+          "message": "Can't resolve $ref: unexpected end of the stream within a single quoted scalar in "fixtures/invalid-yaml.yaml" (2:1)",
           "ruleId": "no-unresolved-refs",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -123,7 +123,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report on unresolved localr ref', async () => {
@@ -148,10 +148,10 @@ describe('oas3 boolean-parameter-prefixes', () => {
     });
 
     expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1test/put/requestBody",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -160,7 +160,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
           "message": "Can't resolve $ref",
           "ruleId": "no-unresolved-refs",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -194,7 +194,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report on nested refs inside specification extensions', async () => {
@@ -223,7 +223,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report on nested refs inside specification extensions for 3.1', async () => {
@@ -252,6 +252,6 @@ describe('oas3 boolean-parameter-prefixes', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results, __dirname)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/async2/__tests__/channels-kebab-case.test.ts

@@ -27,10 +27,10 @@ describe('Async2 channels-kebab-case', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/channels/NOT_A_KEBAB",
               "reportOnKey": true,
               "source": "asyncapi.yaml",
@@ -39,7 +39,7 @@ describe('Async2 channels-kebab-case', () => {
           "message": "\`NOT_A_KEBAB\` does not use kebab-case.",
           "ruleId": "channels-kebab-case",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -68,10 +68,10 @@ describe('Async2 channels-kebab-case', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/channels/snake_kebab",
               "reportOnKey": true,
               "source": "asyncapi.yaml",
@@ -80,7 +80,7 @@ describe('Async2 channels-kebab-case', () => {
           "message": "\`snake_kebab\` does not use kebab-case.",
           "ruleId": "channels-kebab-case",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -110,7 +110,7 @@ describe('Async2 channels-kebab-case', () => {
         'no-path-trailing-slash': 'off',
       }),
     });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('words with hyphens are allowed with "channels-kebab-case" rule', async () => {
@@ -136,6 +136,6 @@ describe('Async2 channels-kebab-case', () => {
         'paths-kebab-case': 'error',
       }),
     });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/async2/__tests__/no-channel-trailing-slash.test.ts

@@ -27,10 +27,10 @@ describe('no-channel-trailing-slash', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/channels/~1trailing~1",
               "reportOnKey": true,
               "source": "asyncapi.yaml",
@@ -39,7 +39,7 @@ describe('no-channel-trailing-slash', () => {
           "message": "\`/trailing/\` should not have a trailing slash.",
           "ruleId": "no-channel-trailing-slash",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -67,7 +67,7 @@ describe('no-channel-trailing-slash', () => {
       config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report on trailing slash in path if the path is root', async () => {
@@ -92,6 +92,6 @@ describe('no-channel-trailing-slash', () => {
       config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/async2/index.ts

@@ -7,8 +7,9 @@ import { TagDescription } from '../common/tag-description';
 import { TagsAlphabetical } from '../common/tags-alphabetical';
 import { ChannelsKebabCase } from './channels-kebab-case';
 import { NoChannelTrailingSlash } from './no-channel-trailing-slash';
+import type { Async2RuleSet } from '../../oas-types';
 
-export const rules = {
+export const rules: Async2RuleSet<'built-in'> = {
   spec: Spec as Async2Rule,
   assertions: Assertions,
   'info-contact': InfoContact,

package/src/rules/common/__tests__/info-license.test.ts

@@ -21,10 +21,10 @@ describe('Oas3 info-license', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/info",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -33,7 +33,7 @@ describe('Oas3 info-license', () => {
           "message": "Info object should contain \`license\` field.",
           "ruleId": "info-license",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -57,6 +57,6 @@ describe('Oas3 info-license', () => {
       config: await makeConfig({ 'info-license': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/common/__tests__/license-url.test.ts

@@ -22,10 +22,10 @@ describe('Oas3 license-url', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/info/license/url",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -34,7 +34,7 @@ describe('Oas3 license-url', () => {
           "message": "License object should contain \`url\` field.",
           "ruleId": "info-license-url",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -58,6 +58,6 @@ describe('Oas3 license-url', () => {
       config: await makeConfig({ 'info-license-url': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/common/__tests__/no-ambiguous-paths.test.ts

@@ -50,10 +50,10 @@ describe('no-ambiguous-paths', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1{id}~1ambiguous",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -62,11 +62,11 @@ describe('no-ambiguous-paths', () => {
           "message": "Paths should resolve unambiguously. Found two ambiguous paths: \`/good/{id}\` and \`/{id}/ambiguous\`.",
           "ruleId": "no-ambiguous-paths",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1ambiguous~1{id}",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -75,11 +75,11 @@ describe('no-ambiguous-paths', () => {
           "message": "Paths should resolve unambiguously. Found two ambiguous paths: \`/{id}/ambiguous\` and \`/ambiguous/{id}\`.",
           "ruleId": "no-ambiguous-paths",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1{entity}~1{id}~1last",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -88,7 +88,7 @@ describe('no-ambiguous-paths', () => {
           "message": "Paths should resolve unambiguously. Found two ambiguous paths: \`/good/{id}/{pet}\` and \`/{entity}/{id}/last\`.",
           "ruleId": "no-ambiguous-paths",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);

package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts

@@ -32,7 +32,7 @@ describe('Oas3 typed enum', () => {
       config: await makeConfig({ 'no-enum-type-mismatch': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report on enum object if all items match type and enum is nullable', async () => {
@@ -65,7 +65,7 @@ describe('Oas3 typed enum', () => {
       config: await makeConfig({ 'no-enum-type-mismatch': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report on enum object if not all items match type', async () => {
@@ -96,19 +96,19 @@ describe('Oas3 typed enum', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1some/get/responses/200/content/application~1json/schema/enum/1",
               "reportOnKey": false,
               "source": "foobar.yaml",
             },
           ],
-          "message": "All values of \`enum\` field must be of the same type as the \`type\` field: expected \\"integer\\" but received \\"string\\".",
+          "message": "All values of \`enum\` field must be of the same type as the \`type\` field: expected "integer" but received "string".",
           "ruleId": "no-enum-type-mismatch",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -144,10 +144,10 @@ describe('Oas3 typed enum', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1some/get/responses/200/content/application~1json/schema/enum/1",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -156,7 +156,7 @@ describe('Oas3 typed enum', () => {
           "message": "Enum value \`string\` must be of allowed types: \`integer,array\`.",
           "ruleId": "no-enum-type-mismatch",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -189,11 +189,11 @@ describe('Oas3 typed enum', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/paths/~1some/get/responses/200/content/application~1json/schema",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -202,7 +202,7 @@ describe('Oas3 typed enum', () => {
           "message": "Expected type \`Schema\` (object) but got \`null\`",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);

package/src/rules/common/__tests__/no-identical-paths.test.ts

@@ -38,10 +38,10 @@ describe('no-identical-paths', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1good~1{hash}",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -50,7 +50,7 @@ describe('no-identical-paths', () => {
           "message": "The path already exists which differs only by path parameter name(s): \`/good/{id}\` and \`/good/{hash}\`.",
           "ruleId": "no-identical-paths",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);

package/src/rules/common/__tests__/no-path-trailing-slash.test.ts

@@ -23,10 +23,10 @@ describe('no-path-trailing-slash', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1bad~1",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -35,7 +35,7 @@ describe('no-path-trailing-slash', () => {
           "message": "\`/bad/\` should not have a trailing slash.",
           "ruleId": "no-path-trailing-slash",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -64,10 +64,10 @@ describe('no-path-trailing-slash', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1bad~1",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -76,7 +76,7 @@ describe('no-path-trailing-slash', () => {
           "message": "\`/bad/\` should not have a trailing slash.",
           "ruleId": "no-path-trailing-slash",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -100,7 +100,7 @@ describe('no-path-trailing-slash', () => {
       config: await makeConfig({ 'no-path-trailing-slash': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report on trailing slash in path if the path is root', async () => {
@@ -121,6 +121,6 @@ describe('no-path-trailing-slash', () => {
       config: await makeConfig({ 'no-path-trailing-slash': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/common/__tests__/operation-2xx-response.test.ts

@@ -25,10 +25,10 @@ describe('Oas3 operation-2xx-response', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1test/put/responses",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -37,7 +37,7 @@ describe('Oas3 operation-2xx-response', () => {
           "message": "Operation must have at least one \`2XX\` response.",
           "ruleId": "operation-2xx-response",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -63,7 +63,7 @@ describe('Oas3 operation-2xx-response', () => {
       config: await makeConfig({ 'operation-2xx-response': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report for present default', async () => {
@@ -86,7 +86,7 @@ describe('Oas3 operation-2xx-response', () => {
       config: await makeConfig({ 'operation-2xx-response': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report even if the responses are null', async () => {
@@ -108,10 +108,10 @@ describe('Oas3 operation-2xx-response', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1test~1/put/responses",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -120,7 +120,7 @@ describe('Oas3 operation-2xx-response', () => {
           "message": "Operation must have at least one \`2XX\` response.",
           "ruleId": "operation-2xx-response",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -149,10 +149,10 @@ describe('Oas3 operation-2xx-response', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/webhooks/~1test~1/put/responses",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -161,7 +161,7 @@ describe('Oas3 operation-2xx-response', () => {
           "message": "Operation must have at least one \`2XX\` response.",
           "ruleId": "operation-2xx-response",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -187,6 +187,6 @@ describe('Oas3 operation-2xx-response', () => {
       config: await makeConfig({ 'operation-2xx-response': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });