@redocly/openapi-core 1.0.0-beta.104 → 1.0.0-beta.107

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

@@ -11,7 +11,7 @@ export const Assertions: Oas3Rule | Oas2Rule = (opts: object) => {
   // that is why we need to iterate through 'opts' values;
   // before - filter only object 'opts' values
   const assertions: any[] = Object.values(opts).filter(
-    (opt: unknown) => typeof opt === 'object' && opt !== null,
+    (opt: unknown) => typeof opt === 'object' && opt !== null
   );
 
   for (const [index, assertion] of assertions.entries()) {
@@ -42,21 +42,21 @@ export const Assertions: Oas3Rule | Oas2Rule = (opts: object) => {
       });
 
     const shouldRunOnKeys: AssertToApply | undefined = assertsToApply.find(
-      (assert: AssertToApply) => assert.runsOnKeys && !assert.runsOnValues,
+      (assert: AssertToApply) => assert.runsOnKeys && !assert.runsOnValues
     );
     const shouldRunOnValues: AssertToApply | undefined = assertsToApply.find(
-      (assert: AssertToApply) => assert.runsOnValues && !assert.runsOnKeys,
+      (assert: AssertToApply) => assert.runsOnValues && !assert.runsOnKeys
     );
 
     if (shouldRunOnValues && !assertion.property) {
       throw new Error(
-        `${shouldRunOnValues.name} can't be used on all keys. Please provide a single property.`,
+        `${shouldRunOnValues.name} can't be used on all keys. Please provide a single property.`
       );
     }
 
     if (shouldRunOnKeys && assertion.property) {
       throw new Error(
-        `${shouldRunOnKeys.name} can't be used on a single property. Please use 'property'.`,
+        `${shouldRunOnKeys.name} can't be used on a single property. Please use 'property'.`
       );
     }
 
@@ -64,7 +64,7 @@ export const Assertions: Oas3Rule | Oas2Rule = (opts: object) => {
       const subjectVisitor = buildSubjectVisitor(
         assertion.property,
         assertsToApply,
-        assertion.context,
+        assertion.context
       );
       const visitorObject = buildVisitorObject(subject, assertion.context, subjectVisitor);
       visitors.push(visitorObject);

package/src/rules/common/info-license-url.ts

@@ -1,15 +1,10 @@
 import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { missingRequiredField } from '../utils';
+import { validateDefinedAndNonEmpty } from '../utils';
 
-export const InfoLicense: Oas3Rule | Oas2Rule = () => {
+export const InfoLicenseUrl: Oas3Rule | Oas2Rule = () => {
   return {
-    Info(info, { report }) {
-      if (!info.license) {
-        report({
-          message: missingRequiredField('Info', 'license'),
-          location: { reportOnKey: true }
-        });
-      }
+    License(license, ctx) {
+      validateDefinedAndNonEmpty('url', license, ctx);
     },
   };
 };

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

@@ -0,0 +1,15 @@
+import { Oas3Rule, Oas2Rule } from '../../visitors';
+import { missingRequiredField } from '../utils';
+
+export const InfoLicense: Oas3Rule | Oas2Rule = () => {
+  return {
+    Info(info, { report }) {
+      if (!info.license) {
+        report({
+          message: missingRequiredField('Info', 'license'),
+          location: { reportOnKey: true },
+        });
+      }
+    },
+  };
+};

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

@@ -10,7 +10,7 @@ export const NoAmbiguousPaths: Oas3Rule | Oas2Rule = () => {
 
       for (const currentPath of Object.keys(pathMap)) {
         const ambiguousPath = seenPaths.find((seenPath) =>
-          arePathsAmbiguous(seenPath, currentPath),
+          arePathsAmbiguous(seenPath, currentPath)
         );
         if (ambiguousPath) {
           report({

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

@@ -10,7 +10,7 @@ export const NoEnumTypeMismatch: Oas3Rule | Oas2Rule = () => {
       if (schema.enum && !Array.isArray(schema.enum)) return;
       if (schema.enum && schema.type && !Array.isArray(schema.type)) {
         const typeMismatchedValues = schema.enum.filter(
-          (item) => !matchesJsonSchemaType(item, schema.type as string, schema.nullable as boolean),
+          (item) => !matchesJsonSchemaType(item, schema.type as string, schema.nullable as boolean)
         );
         for (const mismatchedValue of typeMismatchedValues) {
           report({
@@ -23,26 +23,29 @@ export const NoEnumTypeMismatch: Oas3Rule | Oas2Rule = () => {
       }
 
       if (schema.enum && schema.type && Array.isArray(schema.type)) {
-        const mismatchedResults: { [key: string]: string[]; } = {};
+        const mismatchedResults: { [key: string]: string[] } = {};
         for (const enumValue of schema.enum) {
           mismatchedResults[enumValue] = [];
 
           for (const type of schema.type) {
-            const valid = matchesJsonSchemaType(enumValue, type as string, schema.nullable as boolean);
-            if (!valid)
-              mismatchedResults[enumValue].push(type);
+            const valid = matchesJsonSchemaType(
+              enumValue,
+              type as string,
+              schema.nullable as boolean
+            );
+            if (!valid) mismatchedResults[enumValue].push(type);
           }
 
-          if(mismatchedResults[enumValue].length !== schema.type.length)
+          if (mismatchedResults[enumValue].length !== schema.type.length)
             delete mismatchedResults[enumValue];
-        };
+        }
 
         for (const mismatchedKey of Object.keys(mismatchedResults)) {
           report({
-            message: `Enum value \`${mismatchedKey}\` must be of one type. Allowed types: \`${schema.type}\`.`,
+            message: `Enum value \`${mismatchedKey}\` must be of allowed types: \`${schema.type}\`.`,
             location: location.child(['enum', schema.enum.indexOf(mismatchedKey)]),
           });
-        };
+        }
       }
     },
   };

package/src/rules/common/no-invalid-parameter-examples.ts

@@ -1,9 +1,9 @@
 import { UserContext } from '../../walk';
 import { Oas3Parameter } from '../../typings/openapi';
-import { validateExample } from '../utils';
+import { getAdditionalPropertiesOption, validateExample } from '../utils';
 
 export const NoInvalidParameterExamples: any = (opts: any) => {
-  const disallowAdditionalProperties = opts.disallowAdditionalProperties ?? true;
+  const allowAdditionalProperties = getAdditionalPropertiesOption(opts) ?? false;
   return {
     Parameter: {
       leave(parameter: Oas3Parameter, ctx: UserContext) {
@@ -13,7 +13,7 @@ export const NoInvalidParameterExamples: any = (opts: any) => {
             parameter.schema!,
             ctx.location.child('example'),
             ctx,
-            disallowAdditionalProperties,
+            allowAdditionalProperties
           );
         }
 
@@ -25,7 +25,7 @@ export const NoInvalidParameterExamples: any = (opts: any) => {
                 parameter.schema!,
                 ctx.location.child(['examples', key]),
                 ctx,
-                false,
+                true
               );
             }
           }

package/src/rules/common/no-invalid-schema-examples.ts

@@ -1,9 +1,9 @@
 import { UserContext } from '../../walk';
 import { Oas3_1Schema } from '../../typings/openapi';
-import { validateExample } from '../utils';
+import { getAdditionalPropertiesOption, validateExample } from '../utils';
 
 export const NoInvalidSchemaExamples: any = (opts: any) => {
-  const disallowAdditionalProperties = opts.disallowAdditionalProperties ?? true;
+  const allowAdditionalProperties = getAdditionalPropertiesOption(opts) ?? false;
   return {
     Schema: {
       leave(schema: Oas3_1Schema, ctx: UserContext) {
@@ -14,12 +14,12 @@ export const NoInvalidSchemaExamples: any = (opts: any) => {
               schema,
               ctx.location.child(['examples', schema.examples.indexOf(example)]),
               ctx,
-              disallowAdditionalProperties,
+              allowAdditionalProperties
             );
           }
         }
         if (schema.example) {
-          validateExample(schema.example, schema, ctx.location.child('example'), ctx, false);
+          validateExample(schema.example, schema, ctx.location.child('example'), ctx, true);
         }
       },
     },

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

@@ -12,6 +12,6 @@ export const OperationOperationId: Oas3Rule | Oas2Rule = () => {
           validateDefinedAndNonEmpty('operationId', operation, ctx);
         },
       },
-    }
+    },
   };
 };

package/src/rules/common/operation-parameters-unique.ts

@@ -14,7 +14,7 @@ export const OperationParametersUnique: Oas3Rule | Oas2Rule = () => {
       },
       Parameter(
         parameter: Oas2Parameter | Oas3Parameter,
-        { report, key, parentLocations }: UserContext,
+        { report, key, parentLocations }: UserContext
       ) {
         const paramId = `${parameter.in}___${parameter.name}`;
         if (seenPathParams.has(paramId)) {
@@ -31,7 +31,7 @@ export const OperationParametersUnique: Oas3Rule | Oas2Rule = () => {
         },
         Parameter(
           parameter: Oas2Parameter | Oas3Parameter,
-          { report, key, parentLocations }: UserContext,
+          { report, key, parentLocations }: UserContext
         ) {
           const paramId = `${parameter.in}___${parameter.name}`;
           if (seenOperationParams.has(paramId)) {

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

@@ -12,6 +12,6 @@ export const PathNotIncludeQuery: Oas3Rule | Oas2Rule = () => {
           });
         }
       },
-    }
+    },
   };
 };

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

@@ -16,7 +16,7 @@ export const PathParamsDefined: Oas3Rule | Oas2Rule = () => {
         definedPathParams = new Set();
         currentPath = key as string;
         pathTemplateParams = new Set(
-          Array.from(key!.toString().matchAll(pathRegex)).map((m) => m[1]),
+          Array.from(key!.toString().matchAll(pathRegex)).map((m) => m[1])
         );
       },
       Parameter(parameter: Oas2Parameter | Oas3Parameter, { report, location }: UserContext) {

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

@@ -4,7 +4,10 @@ import { UserContext } from '../../walk';
 export const PathsKebabCase: Oas3Rule | Oas2Rule = () => {
   return {
     PathItem(_path: object, { report, key }: UserContext) {
-      const segments = (key as string).substr(1).split('/').filter(s => s !== ''); // filter out empty segments
+      const segments = (key as string)
+        .substr(1)
+        .split('/')
+        .filter((s) => s !== ''); // filter out empty segments
       if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
         report({
           message: `\`${key}\` does not use kebab-case.`,

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

@@ -10,7 +10,7 @@ export const ScalarPropertyMissingExample: Oas3Rule | Oas2Rule = () => {
   return {
     SchemaProperties(
       properties: { [name: string]: Oas2Schema | Oas3Schema | Oas3_1Schema },
-      { report, location, oasVersion, resolve }: UserContext,
+      { report, location, oasVersion, resolve }: UserContext
     ) {
       for (const propName of Object.keys(properties)) {
         const propSchema = resolve(properties[propName]).node;

package/src/rules/common/spec.ts

@@ -6,7 +6,7 @@ import { isPlainObject } from '../../utils';
 
 export const OasSpec: Oas3Rule | Oas2Rule = () => {
   return {
-    any(node: any, { report, type, location, key, resolve, ignoreNextVisitorsOnNode } ) {
+    any(node: any, { report, type, location, key, resolve, ignoreNextVisitorsOnNode }) {
       const nodeType = oasTypeOf(node);
 
       if (type.items) {
@@ -40,15 +40,16 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
       const allowed = type.allowed?.(node);
       if (allowed && isPlainObject(node)) {
         for (const propName in node) {
-          if (allowed.includes(propName) ||
-           (type.extensionsPrefix && propName.startsWith(type.extensionsPrefix)) ||
-           !Object.keys(type.properties).includes(propName)
+          if (
+            allowed.includes(propName) ||
+            (type.extensionsPrefix && propName.startsWith(type.extensionsPrefix)) ||
+            !Object.keys(type.properties).includes(propName)
           ) {
             continue;
           }
           report({
             message: `The field \`${propName}\` is not allowed here.`,
-            location: location.child([propName]).key()
+            location: location.child([propName]).key(),
           });
         }
       }
@@ -63,7 +64,9 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
         }
         if (!hasProperty)
           report({
-            message: `Must contain at least one of the following fields: ${type.requiredOneOf?.join(', ')}.`,
+            message: `Must contain at least one of the following fields: ${type.requiredOneOf?.join(
+              ', '
+            )}.`,
             location: [{ reportOnKey: true }],
           });
       }
@@ -134,7 +137,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
             report({
               message: `The value of the ${propName} field must be greater than or equal to ${propSchema.minimum}`,
               location: location.child([propName]),
-            })
+            });
           }
         }
       }

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

@@ -25,7 +25,7 @@ export const NoUnresolvedRefs: Oas3Rule = () => {
 export function reportUnresolvedRef(
   resolved: ResolveResult<any>,
   report: (m: Problem) => void,
-  location: Location,
+  location: Location
 ) {
   const error = resolved.error;
   if (error instanceof YamlParseError) {

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

@@ -15,7 +15,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
               in: path
               type: boolean
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -67,7 +67,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
                   schema:
                     type: boolean
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -91,7 +91,7 @@ describe('oas2 boolean-parameter-prefixes', () => {
                 schema:
                   type: boolean
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

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

@@ -20,7 +20,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -50,7 +50,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -80,7 +80,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -114,7 +114,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -140,7 +140,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -173,7 +173,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -205,7 +205,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -229,7 +229,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -261,7 +261,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -292,7 +292,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -313,7 +313,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -342,7 +342,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {

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

@@ -20,7 +20,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -47,7 +47,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -81,7 +81,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -117,7 +117,7 @@ describe('OpenAPI Schema 2.0', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 });

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

@@ -20,7 +20,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -37,7 +37,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -52,7 +52,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -76,7 +76,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -99,7 +99,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -133,7 +133,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         'paths-identical': 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -160,7 +160,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -187,7 +187,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -205,7 +205,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -239,7 +239,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await lintDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 });

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

@@ -1,5 +1,9 @@
 import { outdent } from 'outdent';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../../__tests__/utils';
+import {
+  parseYamlToDocument,
+  replaceSourceWithRef,
+  makeConfig,
+} from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
 import { BaseResolver } from '../../../../resolve';
 
@@ -15,7 +19,7 @@ describe('Referenceable scalars', () => {
             $ref: fixtures/description.md
         paths: {}
       `,
-      __dirname + '/foobar.yaml',
+      __dirname + '/foobar.yaml'
     );
 
     const results = await lintDocument({

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

@@ -1,25 +1,25 @@
-import { LintConfig, RuleConfig, resolveLint } from '../../../../config';
+import { StyleguideConfig, RuleConfig, resolveStyleguideConfig } from '../../../../config';
 import { parseYamlToDocument } from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
 import { BaseResolver } from '../../../../resolve';
 
 export async function lintDoc(
   source: string,
-  rules: Record<string, RuleConfig> = { spec: 'error' },
+  rules: Record<string, RuleConfig> = { spec: 'error' }
 ) {
   const document = parseYamlToDocument(source, 'foobar.yaml');
 
   const results = await lintDocument({
     externalRefResolver: new BaseResolver(),
     document,
-    config: new LintConfig(
-      await resolveLint({
-        lintConfig: {
+    config: new StyleguideConfig(
+      await resolveStyleguideConfig({
+        styleguideConfig: {
           plugins: [],
           extends: [],
           rules,
         },
-      }),
+      })
     ),
   });
 

package/src/rules/oas2/index.ts

@@ -4,8 +4,8 @@ import { NoInvalidSchemaExamples } from '../common/no-invalid-schema-examples';
 import { NoInvalidParameterExamples } from '../common/no-invalid-parameter-examples';
 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 { InfoLicense } from '../common/info-license';
+import { InfoLicenseUrl } from '../common/info-license-url';
 import { BooleanParameterPrefixes } from './boolean-parameter-prefixes';
 import { TagDescription } from '../common/tag-description';
 import { TagsAlphabetical } from '../common/tags-alphabetical';
@@ -57,7 +57,7 @@ export const rules = {
   'no-path-trailing-slash': NoPathTrailingSlash as Oas2Rule,
   'operation-2xx-response': Operation2xxResponse as Oas2Rule,
   'operation-4xx-response': Operation4xxResponse as Oas2Rule,
-  'assertions': Assertions as Oas2Rule,
+  assertions: Assertions as Oas2Rule,
   'operation-operationId-unique': OperationIdUnique as Oas2Rule,
   'operation-parameters-unique': OperationParametersUnique as Oas2Rule,
   'path-parameters-defined': PathParamsDefined as Oas2Rule,