@redocly/openapi-core 1.3.0 → 1.4.1

package/src/rules/common/__tests__/tags-alphabetical.test.ts

@@ -23,10 +23,10 @@ describe('Oas3 tags-alphabetical', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/tags/0",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -35,7 +35,7 @@ describe('Oas3 tags-alphabetical', () => {
           "message": "The \`tags\` array should be in alphabetical order.",
           "ruleId": "tags-alphabetical",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -59,7 +59,7 @@ describe('Oas3 tags-alphabetical', () => {
       config: await makeConfig({ 'tags-alphabetical': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report on tags object if not sorted alphabetically not ignoring case', async () => {
@@ -81,10 +81,10 @@ describe('Oas3 tags-alphabetical', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/tags/0",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -93,7 +93,7 @@ describe('Oas3 tags-alphabetical', () => {
           "message": "The \`tags\` array should be in alphabetical order.",
           "ruleId": "tags-alphabetical",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -117,6 +117,6 @@ describe('Oas3 tags-alphabetical', () => {
       config: await makeConfig({ 'tags-alphabetical': { severity: 'error', ignoreCase: true } }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/common/assertions/__tests__/index.test.ts

@@ -58,39 +58,39 @@ describe('Oas3 assertions', () => {
   it('should return the right visitor structure', () => {
     const visitors = Assertions(opts as any);
     expect(visitors).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "Operation": Object {
+      [
+        {
+          "Operation": {
             "enter": [Function],
           },
         },
-        Object {
-          "Operation": Object {
-            "PathItem": Object {
+        {
+          "Operation": {
+            "PathItem": {
               "enter": [Function],
             },
             "skip": [Function],
           },
         },
-        Object {
-          "Operation": Object {
-            "PathItem": Object {
+        {
+          "Operation": {
+            "PathItem": {
               "enter": [Function],
             },
             "skip": [Function],
           },
         },
-        Object {
-          "Bar": Object {
-            "Baz": Object {
-              "Foo": Object {
+        {
+          "Bar": {
+            "Baz": {
+              "Foo": {
                 "enter": [Function],
               },
             },
           },
         },
-        Object {
-          "any": Object {
+        {
+          "any": {
             "enter": [Function],
           },
         },

package/src/rules/common/assertions/__tests__/utils.test.ts

@@ -59,11 +59,11 @@ describe('Oas3 assertions', () => {
         );
 
         expect(visitors).toMatchInlineSnapshot(`
-          Object {
-            "Foo": Object {
-              "Bar": Object {
-                "Roof": Object {
-                  "Bar": Object {
+          {
+            "Foo": {
+              "Bar": {
+                "Roof": {
+                  "Bar": {
                     "enter": [Function],
                   },
                   "skip": [Function],
@@ -100,10 +100,10 @@ describe('Oas3 assertions', () => {
         );
 
         expect(visitors).toMatchInlineSnapshot(`
-          Object {
-            "Operation": Object {
-              "Responses": Object {
-                "MediaTypesMap": Object {
+          {
+            "Operation": {
+              "Responses": {
+                "MediaTypesMap": {
                   "enter": [Function],
                 },
                 "skip": [Function],

package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts

@@ -25,10 +25,10 @@ describe('oas2 boolean-parameter-prefixes', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1test/parameters/0/name",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -37,7 +37,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
           "message": "Boolean parameter \`a\` should have \`is\` or \`has\` prefix.",
           "ruleId": "boolean-parameter-prefixes",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -76,7 +76,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
       config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report on boolean param with custom prefix', async () => {
@@ -105,6 +105,6 @@ describe('oas2 boolean-parameter-prefixes', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/oas2/__tests__/response-contains-header.test.ts

@@ -36,10 +36,10 @@ describe('Oas2 response-contains-header', () => {
       }),
     });
     expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1accounts~1{accountId}/get/responses/201/headers",
               "reportOnKey": true,
               "source": Source {
@@ -66,14 +66,14 @@ describe('Oas2 response-contains-header', () => {
               },
             },
           ],
-          "message": "Response object must contain a \\"Content-Length\\" header.",
+          "message": "Response object must contain a "Content-Length" header.",
           "ruleId": "response-contains-header",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1accounts~1{accountId}/get/responses/404/headers",
               "reportOnKey": true,
               "source": Source {
@@ -100,10 +100,10 @@ describe('Oas2 response-contains-header', () => {
               },
             },
           ],
-          "message": "Response object must contain a \\"Content-Length\\" header.",
+          "message": "Response object must contain a "Content-Length" header.",
           "ruleId": "response-contains-header",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -142,7 +142,7 @@ describe('Oas2 response-contains-header', () => {
         },
       }),
     });
-    expect(results).toMatchInlineSnapshot(`Array []`);
+    expect(results).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report a response object when there is no `names` section defined', async () => {
@@ -169,6 +169,6 @@ describe('Oas2 response-contains-header', () => {
         },
       }),
     });
-    expect(results).toMatchInlineSnapshot(`Array []`);
+    expect(results).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/oas2/__tests__/response-contains-property.test.ts

@@ -42,10 +42,10 @@ describe('Oas2 response-contains-property', () => {
       }),
     });
     expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1accounts~1{accountId}/get/responses/200/schema/properties",
               "reportOnKey": true,
               "source": Source {
@@ -78,10 +78,10 @@ describe('Oas2 response-contains-property', () => {
               },
             },
           ],
-          "message": "Response object must contain a top-level \\"id\\" property.",
+          "message": "Response object must contain a top-level "id" property.",
           "ruleId": "response-contains-property",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -123,7 +123,7 @@ describe('Oas2 response-contains-property', () => {
         },
       }),
     });
-    expect(results).toMatchInlineSnapshot(`Array []`);
+    expect(results).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report a response object when there is no `names` section defined', async () => {
@@ -150,6 +150,6 @@ describe('Oas2 response-contains-property', () => {
         },
       }),
     });
-    expect(results).toMatchInlineSnapshot(`Array []`);
+    expect(results).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/oas2/__tests__/spec/info.test.ts

@@ -22,8 +22,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/title",
           "message": "Expected type \`string\` but got \`null\`.",
         },
@@ -52,8 +52,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/description",
           "message": "Expected type \`string\` but got \`null\`.",
         },
@@ -82,8 +82,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/termsOfService",
           "message": "Expected type \`string\` but got \`null\`.",
         },
@@ -115,7 +115,7 @@ describe('OpenAPI Schema 2.0', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report if in the Contact Object in URL field is not string', async () => {
@@ -142,8 +142,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/contact/url",
           "message": "Expected type \`string\` but got \`null\`.",
         },
@@ -175,8 +175,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/contact/email",
           "message": "Expected type \`string\` but got \`null\`.",
         },
@@ -206,7 +206,7 @@ describe('OpenAPI Schema 2.0', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report if the License Object missing field Name', async () => {
@@ -231,8 +231,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/license",
           "message": "The field \`name\` must be present on this level.",
         },
@@ -263,8 +263,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/license/url",
           "message": "Expected type \`string\` but got \`null\`.",
         },
@@ -293,7 +293,7 @@ describe('OpenAPI Schema 2.0', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report if the Version field is not provided', async () => {
@@ -315,8 +315,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info",
           "message": "The field \`version\` must be present on this level.",
         },
@@ -344,8 +344,8 @@ describe('OpenAPI Schema 2.0', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/info/version",
           "message": "Expected type \`string\` but got \`null\`.",
         },

package/src/rules/oas2/__tests__/spec/operation.test.ts

@@ -21,7 +21,7 @@ describe('OpenAPI Schema 2.0', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report of a valid PUT operation object', async () => {
@@ -48,7 +48,7 @@ describe('OpenAPI Schema 2.0', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report of a valid Post operation object', async () => {
@@ -82,7 +82,7 @@ describe('OpenAPI Schema 2.0', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report of a valid delete operation object', async () => {
@@ -118,6 +118,6 @@ describe('OpenAPI Schema 2.0', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/oas2/__tests__/spec/paths.test.ts

@@ -21,7 +21,7 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report if Path object is empty ', async () => {
@@ -38,7 +38,7 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should report if Path object is not present ', async () => {
@@ -54,8 +54,8 @@ describe('OpenAPI Schema', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/",
           "message": "The field \`paths\` must be present on this level.",
         },
@@ -77,7 +77,7 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   //Check: no error
@@ -101,8 +101,8 @@ describe('OpenAPI Schema', () => {
         spec: 'error',
       })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "location": "#/paths/ping",
           "message": "Property \`ping\` is not expected here.",
         },
@@ -134,7 +134,7 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         'paths-identical': 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report valid matching URLs', async () => {
@@ -161,7 +161,7 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report in case of ambiguous matching ', async () => {
@@ -188,7 +188,7 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report if Path Item is empty ', async () => {
@@ -206,7 +206,7 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report of a valid Parameter Object', async () => {
@@ -240,6 +240,6 @@ describe('OpenAPI Schema', () => {
       await lintDoc(source, {
         spec: 'error',
       })
-    ).toMatchInlineSnapshot(`Array []`);
+    ).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts

@@ -30,6 +30,6 @@ describe('Referenceable scalars', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });

package/src/rules/oas2/index.ts

@@ -42,7 +42,9 @@ import { ScalarPropertyMissingExample } from '../common/scalar-property-missing-
 import { RequiredStringPropertyMissingMinLength } from '../common/required-string-property-missing-min-length';
 import { SpecStrictRefs } from '../common/spec-strict-refs';
 
-export const rules = {
+import type { Oas2RuleSet } from 'core/src/oas-types';
+
+export const rules: Oas2RuleSet<'built-in'> = {
   spec: Spec as Oas2Rule,
   'no-invalid-schema-examples': NoInvalidSchemaExamples,
   'no-invalid-parameter-examples': NoInvalidParameterExamples,

package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts

@@ -26,10 +26,10 @@ describe('oas3 boolean-parameter-prefixes', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/paths/~1test/parameters/0/name",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -38,7 +38,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
           "message": "Boolean parameter \`a\` should have \`is\` or \`has\` prefix.",
           "ruleId": "boolean-parameter-prefixes",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -77,7 +77,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
       config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report on boolean param with custom prefix', async () => {
@@ -106,6 +106,6 @@ describe('oas3 boolean-parameter-prefixes', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 });