@redocly/openapi-core 1.0.0-beta.49 → 1.0.0-beta.53

package/src/rules/common/__tests__/path-http-verbs-order.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Common path-http-verbs-order', () => {
@@ -24,7 +24,7 @@ describe('Common path-http-verbs-order', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'path-http-verbs-order': 'error' } }),
+      config: makeConfig({ 'path-http-verbs-order': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -88,7 +88,7 @@ describe('Common path-http-verbs-order', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'path-http-verbs-order': 'error' } }),
+      config: makeConfig({ 'path-http-verbs-order': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/common/__tests__/path-not-include-query.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 path-not-include-query', () => {
@@ -20,7 +20,7 @@ describe('Oas3 path-not-include-query', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'path-not-include-query': 'error' } }),
+      config: makeConfig({ 'path-not-include-query': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -57,7 +57,7 @@ describe('Oas3 path-not-include-query', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'path-not-include-query': 'error' } }),
+      config: makeConfig({ 'path-not-include-query': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/common/__tests__/path-params-defined.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 path-params-defined', () => {
@@ -25,7 +25,7 @@ describe('Oas3 path-params-defined', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'path-params-defined': 'error' } }),
+      config: makeConfig({ 'path-params-defined': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -53,7 +53,7 @@ describe('Oas3 path-params-defined', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'path-params-defined': 'error' } }),
+      config: makeConfig({ 'path-params-defined': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -97,7 +97,7 @@ describe('Oas3 path-params-defined', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'path-params-defined': 'error' } }),
+      config: makeConfig({ 'path-params-defined': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`

package/src/rules/common/__tests__/paths-kebab-case.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 paths-kebab-case', () => {
@@ -23,7 +23,7 @@ describe('Oas3 paths-kebab-case', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'paths-kebab-case': 'error' } }),
+      config: makeConfig({ 'paths-kebab-case': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -62,7 +62,7 @@ describe('Oas3 paths-kebab-case', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'paths-kebab-case': 'error' } }),
+      config: makeConfig({ 'paths-kebab-case': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`

package/src/rules/common/__tests__/tag-description.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 tag-description', () => {
@@ -20,7 +20,7 @@ describe('Oas3 tag-description', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'tag-description': 'error' } }),
+      config: makeConfig({ 'tag-description': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -58,7 +58,7 @@ describe('Oas3 tag-description', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'tag-description': 'error' } }),
+      config: makeConfig({ 'tag-description': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

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

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 tags-alphabetical', () => {
@@ -20,7 +20,7 @@ describe('Oas3 tags-alphabetical', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'tags-alphabetical': 'error' } }),
+      config: makeConfig({ 'tags-alphabetical': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -57,7 +57,7 @@ describe('Oas3 tags-alphabetical', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'tags-alphabetical': 'error' } }),
+      config: makeConfig({ 'tags-alphabetical': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/common/operation-operationId.ts

@@ -6,8 +6,12 @@ import { Oas3Operation } from '../../typings/openapi';
 
 export const OperationOperationId: Oas3Rule | Oas2Rule = () => {
   return {
-    Operation(operation: Oas2Operation | Oas3Operation, ctx: UserContext) {
-      validateDefinedAndNonEmpty('operationId', operation, ctx);
-    },
+    DefinitionRoot: {
+      PathItem: {
+        Operation(operation: Oas2Operation | Oas3Operation, ctx: UserContext) {
+          validateDefinedAndNonEmpty('operationId', operation, ctx);
+        },
+      },
+    }
   };
 };

package/src/rules/common/spec.ts

@@ -5,19 +5,22 @@ import { isRef } from '../../ref-utils';
 
 export const OasSpec: Oas3Rule | Oas2Rule = () => {
   return {
-    any(node: any, { report, type, location, key, resolve }) {
+    any(node: any, { report, type, location, key, resolve, ignoreNextVisitorsOnNode } ) {
       const nodeType = oasTypeOf(node);
+
       if (type.items) {
         if (nodeType !== 'array') {
           report({
             message: `Expected type \`${type.name}\` (array) but got \`${nodeType}\``,
           });
+          ignoreNextVisitorsOnNode();
         }
         return;
       } else if (nodeType !== 'object') {
         report({
           message: `Expected type \`${type.name}\` (object) but got \`${nodeType}\``,
         });
+        ignoreNextVisitorsOnNode();
         return;
       }
 

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

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { lintDocument } from '../../../lint';
-import { LintConfig } from '../../..';
 import { BaseResolver } from '../../../resolve';
 
 describe('oas2 boolean-parameter-prefixes', () => {
@@ -22,7 +22,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'boolean-parameter-prefixes': 'error' } }),
+      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -74,7 +74,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'boolean-parameter-prefixes': 'error' } }),
+      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -98,13 +98,10 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          'boolean-parameter-prefixes': {
-            severity: 'error',
-            prefixes: ['should'],
-          },
+      config: makeConfig({
+        'boolean-parameter-prefixes': {
+          severity: 'error',
+          prefixes: ['should'],
         },
       }),
     });

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

@@ -1,8 +1,8 @@
 import { outdent } from 'outdent';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
-import { LintConfig } from '../../../..';
 import { BaseResolver } from '../../../../resolve';
+import { makeConfig } from '../../../__tests__/config';
 
 describe('Referenceable scalars', () => {
   it('should not report $ref description', async () => {
@@ -22,11 +22,8 @@ describe('Referenceable scalars', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          spec: 'error',
-        },
+      config: makeConfig({
+        spec: 'error',
       }),
     });
 

package/src/rules/oas2/__tests__/spec/utils.ts

@@ -2,6 +2,7 @@ import { LintConfig, RuleConfig } from '../../../../config/config';
 import { parseYamlToDocument } from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
 import { BaseResolver } from '../../../../resolve';
+import { defaultPlugin } from '../../../../config/builtIn';
 
 export async function lintDoc(
   source: string,
@@ -13,6 +14,7 @@ export async function lintDoc(
     externalRefResolver: new BaseResolver(),
     document,
     config: new LintConfig({
+      plugins: [defaultPlugin],
       extends: [],
       rules,
     }),

package/src/rules/oas2/index.ts

@@ -3,7 +3,6 @@ import { InfoDescription } from '../common/info-description';
 import { InfoContact } from '../common/info-contact';
 import { InfoLicense } from '../common/info-license-url';
 import { InfoLicenseUrl } from '../common/license-url';
-
 import { BooleanParameterPrefixes } from './boolean-parameter-prefixes';
 import { TagDescription } from '../common/tag-description';
 import { TagsAlphabetical } from '../common/tags-alphabetical';
@@ -32,31 +31,26 @@ import { OperationSummary } from '../common/operation-summary';
 import { NoAmbiguousPaths } from '../common/no-ambiguous-paths';
 
 export const rules = {
+  spec: OasSpec as Oas2Rule,
   'info-description': InfoDescription as Oas2Rule,
   'info-contact': InfoContact as Oas2Rule,
   'info-license': InfoLicense as Oas2Rule,
   'info-license-url': InfoLicenseUrl as Oas2Rule,
-
   'tag-description': TagDescription as Oas2Rule,
   'tags-alphabetical': TagsAlphabetical as Oas2Rule,
-
   'paths-kebab-case': PathsKebabCase as Oas2Rule,
   'no-enum-type-mismatch': NoEnumTypeMismatch as Oas2Rule,
-
   'boolean-parameter-prefixes': BooleanParameterPrefixes as Oas2Rule,
   'no-path-trailing-slash': NoPathTrailingSlash as Oas2Rule,
   'operation-2xx-response': Operation2xxResponse as Oas2Rule,
-
   'operation-operationId-unique': OperationIdUnique as Oas2Rule,
   'operation-parameters-unique': OperationParametersUnique as Oas2Rule,
   'path-parameters-defined': PathParamsDefined as Oas2Rule,
   'operation-tag-defined': OperationTagDefined as Oas2Rule,
-
   'path-declaration-must-exist': PathDeclarationMustExist as Oas2Rule,
   'operation-operationId-url-safe': OperationIdUrlSafe as Oas2Rule,
   'operation-operationId': OperationOperationId as Oas2Rule,
   'operation-summary': OperationSummary as Oas2Rule,
-
   'operation-description': OperationDescription as Oas2Rule,
   'path-not-include-query': PathNotIncludeQuery as Oas2Rule,
   'path-params-defined': PathParamsDefined as Oas2Rule,
@@ -66,10 +60,7 @@ export const rules = {
   'no-unresolved-refs': NoUnresolvedRefs as Oas2Rule,
   'no-identical-paths': NoIdenticalPaths as Oas2Rule,
   'no-ambiguous-paths': NoAmbiguousPaths as Oas2Rule,
-
   'path-http-verbs-order': PathHttpVerbsOrder as Oas2Rule,
-
-  spec: OasSpec as Oas2Rule,
 };
 
 export const preprocessors = {};

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

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { lintDocument } from '../../../lint';
-import { LintConfig } from '../../..';
 import { BaseResolver } from '../../../resolve';
 
 describe('oas3 boolean-parameter-prefixes', () => {
@@ -23,7 +23,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'boolean-parameter-prefixes': 'error' } }),
+      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -75,7 +75,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'boolean-parameter-prefixes': 'error' } }),
+      config: makeConfig({ 'boolean-parameter-prefixes': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -99,13 +99,10 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          'boolean-parameter-prefixes': {
-            severity: 'error',
-            prefixes: ['should'],
-          },
+      config: makeConfig({
+        'boolean-parameter-prefixes': {
+          severity: 'error',
+          prefixes: ['should'],
         },
       }),
     });

package/src/rules/oas3/__tests__/fixtures/common.yaml

@@ -0,0 +1,11 @@
+components:
+  schemas:
+    A:
+      type: object
+      properties:
+        a:
+          type: string
+        b:
+          $ref: '#/components/schemas/B'
+    B:
+      type: string

package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts

@@ -1,8 +1,8 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
+import { makeConfig } from '../../__tests__/config';
 
 describe('Oas3 as3-no-servers-empty-enum', () => {
   it('oas3-no-servers-empty-enum: should report on server object with empty enum and unknown enum value', async () => {
@@ -25,7 +25,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-servers-empty-enum': 'error' } }),
+      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -79,7 +79,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-servers-empty-enum': 'error' } }),
+      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -118,7 +118,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-servers-empty-enum': 'error' } }),
+      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -142,7 +142,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-servers-empty-enum': 'error' } }),
+      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -169,7 +169,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-servers-empty-enum': 'error' } }),
+      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -198,7 +198,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-servers-empty-enum': 'error' } }),
+      config: makeConfig({ 'no-servers-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts

@@ -1,8 +1,8 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
+import { makeConfig } from '../../__tests__/config';
 
 describe('Oas3 oas3-no-example-value-and-externalValue', () => {
   it('oas3-no-example-value-and-externalValue: should report on example object with both value and external value', async () => {
@@ -21,10 +21,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: { 'no-example-value-and-externalValue': 'error' },
-      }),
+      config: makeConfig({ 'no-example-value-and-externalValue': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -61,10 +58,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: { 'no-example-value-and-externalValue': 'error' },
-      }),
+      config: makeConfig({ 'no-example-value-and-externalValue': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);