@redocly/openapi-core 1.18.1 → 1.20.0

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

@@ -1,5 +1,5 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { UserContext } from '../../walk';
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
 
 export const PathNotIncludeQuery: Oas3Rule | Oas2Rule = () => {
   return {

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

@@ -1,7 +1,7 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { Oas2Parameter } from '../../typings/swagger';
-import { Oas3Parameter } from '../../typings/openapi';
-import { UserContext } from '../../walk';
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { Oas2Parameter } from '../../typings/swagger';
+import type { Oas3Parameter } from '../../typings/openapi';
+import type { UserContext } from '../../walk';
 
 const pathRegex = /\{([a-zA-Z0-9_.-]+)\}+/g;
 

package/src/rules/common/path-segment-plural.ts

@@ -1,8 +1,9 @@
 import * as pluralize from 'pluralize';
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { UserContext } from '../../walk';
 import { isPathParameter } from '../../utils';
 
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
+
 export const PathSegmentPlural: Oas3Rule | Oas2Rule = (opts) => {
   const { ignoreLastPathSegment, exceptions } = opts;
   return {

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

@@ -1,5 +1,5 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { UserContext } from '../../walk';
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
 
 export const PathsKebabCase: Oas3Rule | Oas2Rule = () => {
   return {

package/src/rules/common/required-string-property-missing-min-length.ts

@@ -1,7 +1,7 @@
-import { UserContext } from '../../walk';
-import { Oas3Schema, Oas3_1Schema } from '../../typings/openapi';
-import { Oas2Schema } from 'core/src/typings/swagger';
-import { Oas3Rule } from 'core/src/visitors';
+import type { UserContext } from '../../walk';
+import type { Oas3Schema, Oas3_1Schema } from '../../typings/openapi';
+import type { Oas2Schema } from 'core/src/typings/swagger';
+import type { Oas3Rule } from 'core/src/visitors';
 
 export const RequiredStringPropertyMissingMinLength: Oas3Rule = () => {
   let skipSchemaProperties: boolean;

package/src/rules/common/response-contains-header.ts

@@ -1,9 +1,10 @@
-import { Oas2Rule, Oas3Rule } from '../../visitors';
-import { UserContext } from '../../walk';
-import { Oas3Response } from '../../typings/openapi';
-import { Oas2Response } from '../../typings/swagger';
 import { getMatchingStatusCodeRange } from '../../utils';
 
+import type { Oas2Rule, Oas3Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
+import type { Oas3Response } from '../../typings/openapi';
+import type { Oas2Response } from '../../typings/swagger';
+
 export const ResponseContainsHeader: Oas3Rule | Oas2Rule = (options) => {
   const names: Record<string, string[]> = options.names || {};
   return {

package/src/rules/common/scalar-property-missing-example.ts

@@ -1,8 +1,9 @@
+import { SpecVersion } from '../../oas-types';
+
 import type { Oas2Rule, Oas3Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
 import type { Oas2Schema } from '../../typings/swagger';
 import type { Oas3Schema, Oas3_1Schema } from '../../typings/openapi';
-import { SpecVersion } from '../../oas-types';
 
 const SCALAR_TYPES = ['string', 'integer', 'number', 'boolean', 'null'];
 

package/src/rules/common/security-defined.ts

@@ -1,13 +1,13 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { Location } from '../../ref-utils';
-import { UserContext } from '../../walk';
-import {
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { Location } from '../../ref-utils';
+import type { UserContext } from '../../walk';
+import type {
   Oas2Definition,
   Oas2Operation,
   Oas2PathItem,
   Oas2SecurityScheme,
 } from '../../typings/swagger';
-import {
+import type {
   Oas3Definition,
   Oas3Operation,
   Oas3PathItem,

package/src/rules/common/spec-strict-refs.ts

@@ -1,6 +1,7 @@
-import { Oas2Rule, Oas3Rule } from '../../visitors';
 import { isRef } from '../../ref-utils';
 
+import type { Oas2Rule, Oas3Rule } from '../../visitors';
+
 export const SpecStrictRefs: Oas3Rule | Oas2Rule = () => {
   const nodesToSkip = [
     'Schema',

package/src/rules/common/spec.ts

@@ -1,11 +1,12 @@
-import type { Oas3Rule, Oas2Rule, Async2Rule, ArazzoRule } from '../../visitors';
 import { isNamedType, SpecExtension } from '../../types';
 import { oasTypeOf, matchesJsonSchemaType, getSuggest, validateSchemaEnumType } from '../utils';
 import { isRef } from '../../ref-utils';
 import { isPlainObject } from '../../utils';
-import { UserContext } from '../../walk';
 
-export const Spec: Oas3Rule | Oas2Rule | Async2Rule | ArazzoRule = () => {
+import type { UserContext } from '../../walk';
+import type { Oas3Rule, Oas2Rule, Async2Rule, Async3Rule, ArazzoRule } from '../../visitors';
+
+export const Spec: Oas3Rule | Oas2Rule | Async2Rule | Async3Rule | ArazzoRule = () => {
   return {
     any(
       node: any,

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

@@ -1,6 +1,7 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
 import { validateDefinedAndNonEmpty } from '../utils';
 
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
+
 export const TagDescription: Oas3Rule | Oas2Rule = () => {
   return {
     Tag(tag, ctx) {

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

@@ -1,7 +1,7 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { Oas2Definition, Oas2Tag } from '../../typings/swagger';
-import { Oas3Definition, Oas3Tag } from '../../typings/openapi';
-import { UserContext } from '../../walk';
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { Oas2Definition, Oas2Tag } from '../../typings/swagger';
+import type { Oas3Definition, Oas3Tag } from '../../typings/openapi';
+import type { UserContext } from '../../walk';
 
 export const TagsAlphabetical: Oas3Rule | Oas2Rule = ({ ignoreCase = false }) => {
   return {

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

@@ -1,7 +1,8 @@
-import { Oas3Rule } from '../visitors';
 import { YamlParseError } from '../resolve';
-import { ResolveResult, Problem } from '../walk';
-import { Location } from '../ref-utils';
+
+import type { Oas3Rule } from '../visitors';
+import type { ResolveResult, Problem } from '../walk';
+import type { Location } from '../ref-utils';
 
 export const NoUnresolvedRefs: Oas3Rule = () => {
   return {

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

@@ -21,7 +21,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ rules: { 'boolean-parameter-prefixes': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -73,7 +73,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ rules: { 'boolean-parameter-prefixes': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -98,9 +98,11 @@ describe('oas2 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'boolean-parameter-prefixes': {
-          severity: 'error',
-          prefixes: ['should'],
+        rules: {
+          'boolean-parameter-prefixes': {
+            severity: 'error',
+            prefixes: ['should'],
+          },
         },
       }),
     });

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

@@ -29,9 +29,11 @@ describe('Oas2 response-contains-header', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: { '2xx': ['Content-Length'], '4xx': ['Content-Length'] },
+        rules: {
+          'response-contains-header': {
+            severity: 'error',
+            names: { '2xx': ['Content-Length'], '4xx': ['Content-Length'] },
+          },
         },
       }),
     });
@@ -136,9 +138,11 @@ describe('Oas2 response-contains-header', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: { '2xx': ['Content-Length'], '400': ['Content-Length'] },
+        rules: {
+          'response-contains-header': {
+            severity: 'error',
+            names: { '2xx': ['Content-Length'], '400': ['Content-Length'] },
+          },
         },
       }),
     });
@@ -164,8 +168,10 @@ describe('Oas2 response-contains-header', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
+        rules: {
+          'response-contains-header': {
+            severity: 'error',
+          },
         },
       }),
     });

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

@@ -35,9 +35,11 @@ describe('Oas2 response-contains-property', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { '2xx': ['id'], '4xx': ['id'] },
+        rules: {
+          'response-contains-property': {
+            severity: 'error',
+            names: { '2xx': ['id'], '4xx': ['id'] },
+          },
         },
       }),
     });
@@ -117,9 +119,11 @@ describe('Oas2 response-contains-property', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { '200': ['id'], '4xx': ['id'] },
+        rules: {
+          'response-contains-property': {
+            severity: 'error',
+            names: { '200': ['id'], '4xx': ['id'] },
+          },
         },
       }),
     });
@@ -145,8 +149,10 @@ describe('Oas2 response-contains-property', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
+        rules: {
+          'response-contains-property': {
+            severity: 'error',
+          },
         },
       }),
     });

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

@@ -26,7 +26,9 @@ describe('Referenceable scalars', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        spec: 'error',
+        rules: {
+          spec: 'error',
+        },
       }),
     });
 

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

@@ -1,4 +1,4 @@
-import { Oas2Rule } from '../../visitors';
+import type { Oas2Rule } from '../../visitors';
 
 export type BooleanParameterPrefixesOptions = {
   prefixes?: string[];

package/src/rules/oas2/index.ts

@@ -1,10 +1,10 @@
-import { Oas2Rule } from '../../visitors';
 import { Spec } from '../common/spec';
 import { NoInvalidSchemaExamples } from '../common/no-invalid-schema-examples';
 import { NoInvalidParameterExamples } from '../common/no-invalid-parameter-examples';
 import { InfoContact } from '../common/info-contact';
 import { InfoLicense } from '../common/info-license';
 import { InfoLicenseUrl } from '../common/info-license-url';
+import { InfoLicenseStrict } from '../common/info-license-strict';
 import { BooleanParameterPrefixes } from './boolean-parameter-prefixes';
 import { TagDescription } from '../common/tag-description';
 import { TagsAlphabetical } from '../common/tags-alphabetical';
@@ -43,7 +43,8 @@ import { RequiredStringPropertyMissingMinLength } from '../common/required-strin
 import { SpecStrictRefs } from '../common/spec-strict-refs';
 import { NoRequiredSchemaPropertiesUndefined } from '../common/no-required-schema-properties-undefined';
 
-import type { Oas2RuleSet } from 'core/src/oas-types';
+import type { Oas2Rule } from '../../visitors';
+import type { Oas2RuleSet } from '../../oas-types';
 
 export const rules: Oas2RuleSet<'built-in'> = {
   spec: Spec as Oas2Rule,
@@ -52,6 +53,7 @@ export const rules: Oas2RuleSet<'built-in'> = {
   'info-contact': InfoContact as Oas2Rule,
   'info-license': InfoLicense as Oas2Rule,
   'info-license-url': InfoLicenseUrl as Oas2Rule,
+  'info-license-strict': InfoLicenseStrict as Oas2Rule,
   'tag-description': TagDescription as Oas2Rule,
   'tags-alphabetical': TagsAlphabetical as Oas2Rule,
   'paths-kebab-case': PathsKebabCase as Oas2Rule,
@@ -86,10 +88,10 @@ export const rules: Oas2RuleSet<'built-in'> = {
   'path-segment-plural': PathSegmentPlural as Oas2Rule,
   'response-contains-header': ResponseContainsHeader as Oas2Rule,
   'response-contains-property': ResponseContainsProperty as Oas2Rule,
-  'scalar-property-missing-example': ScalarPropertyMissingExample,
-  'required-string-property-missing-min-length': RequiredStringPropertyMissingMinLength,
-  'spec-strict-refs': SpecStrictRefs,
-  'no-required-schema-properties-undefined': NoRequiredSchemaPropertiesUndefined,
+  'scalar-property-missing-example': ScalarPropertyMissingExample as Oas2Rule,
+  'required-string-property-missing-min-length': RequiredStringPropertyMissingMinLength as Oas2Rule,
+  'spec-strict-refs': SpecStrictRefs as Oas2Rule,
+  'no-required-schema-properties-undefined': NoRequiredSchemaPropertiesUndefined as Oas2Rule,
 };
 
 export const preprocessors = {};

package/src/rules/oas2/request-mime-type.ts

@@ -1,6 +1,7 @@
+import { validateMimeType } from '../../utils';
+
 import type { Oas2Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
-import { validateMimeType } from '../../utils';
 
 export const RequestMimeType: Oas2Rule = ({ allowedValues }) => {
   return {

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

@@ -1,7 +1,8 @@
-import { Oas2Rule } from '../../visitors';
-import { UserContext } from '../../walk';
 import { getMatchingStatusCodeRange } from '../../utils';
 
+import type { Oas2Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
+
 export const ResponseContainsProperty: Oas2Rule = (options) => {
   const names: Record<string, string[]> = options.names || {};
   let key: string | number;

package/src/rules/oas2/response-mime-type.ts

@@ -1,6 +1,7 @@
+import { validateMimeType } from '../../utils';
+
 import type { Oas2Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
-import { validateMimeType } from '../../utils';
 
 export const ResponseMimeType: Oas2Rule = ({ allowedValues }) => {
   return {

package/src/rules/oas3/__tests__/array-parameter-serialization.test.ts

@@ -30,7 +30,9 @@ describe('oas3 array-parameter-serialization', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        rules: {
+          'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -73,7 +75,9 @@ describe('oas3 array-parameter-serialization', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        rules: {
+          'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -126,7 +130,9 @@ describe('oas3 array-parameter-serialization', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        rules: {
+          'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -170,7 +176,9 @@ describe('oas3 array-parameter-serialization', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        rules: {
+          'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -194,7 +202,9 @@ describe('oas3 array-parameter-serialization', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        rules: {
+          'array-parameter-serialization': { severity: 'error', in: ['query'] },
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -226,7 +236,9 @@ describe('oas3 array-parameter-serialization', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'array-parameter-serialization': { severity: 'error' },
+        rules: {
+          'array-parameter-serialization': { severity: 'error' },
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`

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

@@ -22,7 +22,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ rules: { 'boolean-parameter-prefixes': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -74,7 +74,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'boolean-parameter-prefixes': 'error' }),
+      config: await makeConfig({ rules: { 'boolean-parameter-prefixes': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -99,9 +99,11 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'boolean-parameter-prefixes': {
-          severity: 'error',
-          prefixes: ['should'],
+        rules: {
+          'boolean-parameter-prefixes': {
+            severity: 'error',
+            prefixes: ['should'],
+          },
         },
       }),
     });

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

@@ -24,7 +24,7 @@ describe('Oas3 as3-no-server-variables-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+      config: await makeConfig({ rules: { 'no-server-variables-empty-enum': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -78,7 +78,7 @@ describe('Oas3 as3-no-server-variables-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+      config: await makeConfig({ rules: { 'no-server-variables-empty-enum': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -117,7 +117,7 @@ describe('Oas3 as3-no-server-variables-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+      config: await makeConfig({ rules: { 'no-server-variables-empty-enum': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -141,7 +141,7 @@ describe('Oas3 as3-no-server-variables-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+      config: await makeConfig({ rules: { 'no-server-variables-empty-enum': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -168,7 +168,7 @@ describe('Oas3 as3-no-server-variables-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+      config: await makeConfig({ rules: { 'no-server-variables-empty-enum': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -197,7 +197,7 @@ describe('Oas3 as3-no-server-variables-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+      config: await makeConfig({ rules: { 'no-server-variables-empty-enum': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);

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

@@ -20,7 +20,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-example-value-and-externalValue': 'error' }),
+      config: await makeConfig({ rules: { 'no-example-value-and-externalValue': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -57,7 +57,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-example-value-and-externalValue': 'error' }),
+      config: await makeConfig({ rules: { 'no-example-value-and-externalValue': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);