@redocly/openapi-core 1.0.0-beta.105 → 1.0.0-beta.108

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

@@ -23,7 +23,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -43,7 +43,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -61,7 +61,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -88,7 +88,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -114,7 +114,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -151,7 +151,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         'no-identical-paths': 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -188,7 +188,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -218,7 +218,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -239,7 +239,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -278,7 +278,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 });

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

@@ -1,9 +1,9 @@
 import { outdent } from 'outdent';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
-import { LintConfig } from '../../../..';
+import { StyleguideConfig } from '../../../..';
 import { BaseResolver } from '../../../../resolve';
-import { resolveLint } from '../../../../config';
+import { resolveStyleguideConfig } from '../../../../config';
 
 describe('Referenceable scalars', () => {
   it('should not report $ref description', async () => {
@@ -17,22 +17,22 @@ describe('Referenceable scalars', () => {
               $ref: fixtures/description.md
           paths: {}
         `,
-      __dirname + '/foobar.yaml',
+      __dirname + '/foobar.yaml'
     );
 
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig(
-        await resolveLint({
-          lintConfig: {
+      config: new StyleguideConfig(
+        await resolveStyleguideConfig({
+          styleguideConfig: {
             extends: [],
             rules: {
               spec: 'error',
               'no-unresolved-refs': 'error',
             },
           },
-        }),
+        })
       ),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -54,22 +54,22 @@ describe('Referenceable scalars', () => {
                     example:
                       $ref: not $ref, example
         `,
-      __dirname + '/foobar.yaml',
+      __dirname + '/foobar.yaml'
     );
 
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig(
-        await resolveLint({
-          lintConfig: {
+      config: new StyleguideConfig(
+        await resolveStyleguideConfig({
+          styleguideConfig: {
             extends: [],
             rules: {
               'no-unresolved-refs': 'error',
             },
             doNotResolveExamples: true,
           },
-        }),
+        })
       ),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/spec/servers.test.ts

@@ -24,7 +24,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -49,7 +49,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -81,7 +81,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -114,7 +114,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -146,7 +146,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -171,7 +171,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -208,7 +208,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -243,7 +243,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -277,7 +277,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -317,7 +317,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         'no-undefined-server-variable': 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -357,7 +357,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -403,7 +403,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -447,7 +447,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -469,7 +469,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -493,7 +493,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 });

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -1,13 +1,13 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__tests__/utils';
-import { LintConfig, defaultPlugin, resolvePlugins, resolvePreset } from '../../../../config';
+import { StyleguideConfig, defaultPlugin, resolvePlugins, resolvePreset } from '../../../../config';
 
 import { BaseResolver } from '../../../../resolve';
 
 const plugins = resolvePlugins([defaultPlugin]);
 const pressets = resolvePreset('all', plugins);
-const allConfig = new LintConfig({ ...pressets, plugins });
+const allConfig = new StyleguideConfig({ ...pressets, plugins });
 describe('Oas3 Structural visitor basic', () => {
   it('should report wrong types', async () => {
     const document = parseYamlToDocument(
@@ -35,7 +35,7 @@ describe('Oas3 Structural visitor basic', () => {
             license: invalid
           paths: {}
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -110,7 +110,7 @@ describe('Oas3 Structural visitor basic', () => {
               "source": "foobar.yaml",
             },
           ],
-          "message": "Expected type \`string\` but got \`number\`.",
+          "message": "Expected type \`string\` but got \`integer\`.",
           "ruleId": "spec",
           "severity": "error",
           "suggest": Array [],
@@ -163,7 +163,7 @@ describe('Oas3 Structural visitor basic', () => {
               x-test: vendor
           paths: {}
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -232,7 +232,7 @@ describe('Oas3 Structural visitor basic', () => {
             contact:
               name: string
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

package/src/rules/oas3/__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 validateDoc(
   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/oas3/index.ts

@@ -18,13 +18,13 @@ import { NoServerTrailingSlash } from './no-server-trailing-slash';
 import { InfoDescription } from '../common/info-description';
 import { TagDescription } from '../common/tag-description';
 import { InfoContact } from '../common/info-contact';
-import { InfoLicense } from '../common/info-license-url';
+import { InfoLicense } from '../common/info-license';
+import { InfoLicenseUrl } from '../common/info-license-url';
 import { OperationDescription } from '../common/operation-description';
 import { NoUnusedComponents } from './no-unused-components';
 import { PathNotIncludeQuery } from '../common/path-not-include-query';
 import { ParameterDescription } from '../common/parameter-description';
 import { OperationSingularTag } from '../common/operation-singular-tag';
-import { InfoLicenseUrl } from '../common/license-url';
 import { OperationSecurityDefined } from '../common/operation-security-defined';
 import { NoUnresolvedRefs } from '../no-unresolved-refs';
 import { BooleanParameterPrefixes } from './boolean-parameter-prefixes';
@@ -37,7 +37,7 @@ import { NoUndefinedServerVariable } from './no-undefined-server-variable';
 import { OperationOperationId } from '../common/operation-operationId';
 import { OperationSummary } from '../common/operation-summary';
 import { NoAmbiguousPaths } from '../common/no-ambiguous-paths';
-import { NoEmptyEnumServers } from './no-servers-empty-enum';
+import { NoServerVariablesEmptyEnum } from './no-server-variables-empty-enum';
 import { NoHttpVerbsInPaths } from '../common/no-http-verbs-in-paths';
 import { RequestMimeType } from './request-mime-type';
 import { ResponseMimeType } from './response-mime-type';
@@ -57,7 +57,7 @@ export const rules = {
   'info-license-url': InfoLicenseUrl,
   'operation-2xx-response': Operation2xxResponse,
   'operation-4xx-response': Operation4xxResponse,
-  'assertions': Assertions,
+  assertions: Assertions,
   'operation-operationId-unique': OperationIdUnique,
   'operation-parameters-unique': OperationParametersUnique,
   'path-parameters-defined': PathParamsDefined,
@@ -89,7 +89,7 @@ export const rules = {
   'no-identical-paths': NoIdenticalPaths,
   'no-ambiguous-paths': NoAmbiguousPaths,
   'no-undefined-server-variable': NoUndefinedServerVariable,
-  'no-servers-empty-enum': NoEmptyEnumServers,
+  'no-server-variables-empty-enum': NoServerVariablesEmptyEnum,
   'no-http-verbs-in-paths': NoHttpVerbsInPaths,
   'path-excludes-patterns': PathExcludesPatterns,
   'request-mime-type': RequestMimeType,

package/src/rules/oas3/no-empty-servers.ts

@@ -6,7 +6,7 @@ export const NoEmptyServers: Oas3Rule = () => {
       if (!root.hasOwnProperty('servers')) {
         report({
           message: 'Servers must be present.',
-          location: location.child(['openapi']).key()
+          location: location.child(['openapi']).key(),
         });
         return;
       }

package/src/rules/oas3/no-invalid-media-type-examples.ts

@@ -1,11 +1,11 @@
 import { Oas3Rule } from '../../visitors';
 import { Location, isRef } from '../../ref-utils';
 import { Oas3Example } from '../../typings/openapi';
-import { validateExample } from '../utils';
+import { getAdditionalPropertiesOption, validateExample } from '../utils';
 import { UserContext } from '../../walk';
 
 export const ValidContentExamples: Oas3Rule = (opts) => {
-  const disallowAdditionalProperties = opts.disallowAdditionalProperties ?? true;
+  const allowAdditionalProperties = getAdditionalPropertiesOption(opts) ?? false;
 
   return {
     MediaType: {
@@ -13,14 +13,22 @@ export const ValidContentExamples: Oas3Rule = (opts) => {
         const { location, resolve } = ctx;
         if (!mediaType.schema) return;
         if (mediaType.example) {
-         resolveAndValidateExample(mediaType.example, location.child('example'));
+          resolveAndValidateExample(mediaType.example, location.child('example'));
         } else if (mediaType.examples) {
           for (const exampleName of Object.keys(mediaType.examples)) {
-            resolveAndValidateExample(mediaType.examples[exampleName], location.child(['examples', exampleName, 'value']), true);
+            resolveAndValidateExample(
+              mediaType.examples[exampleName],
+              location.child(['examples', exampleName, 'value']),
+              true
+            );
           }
         }
 
-        function resolveAndValidateExample(example: Oas3Example | any, location: Location, isMultiple?: boolean) {
+        function resolveAndValidateExample(
+          example: Oas3Example | any,
+          location: Location,
+          isMultiple?: boolean
+        ) {
           if (isRef(example)) {
             const resolved = resolve<Oas3Example>(example);
             if (!resolved.location) return;
@@ -32,7 +40,7 @@ export const ValidContentExamples: Oas3Rule = (opts) => {
             mediaType.schema!,
             location,
             ctx,
-            disallowAdditionalProperties,
+            allowAdditionalProperties
           );
         }
       },

package/src/rules/oas3/{no-servers-empty-enum.ts → no-server-variables-empty-enum.ts}

@@ -6,7 +6,7 @@ enum enumError {
   invalidDefaultValue = 'invalidDefaultValue',
 }
 
-export const NoEmptyEnumServers: Oas3Rule = () => {
+export const NoServerVariablesEmptyEnum: Oas3Rule = () => {
   return {
     DefinitionRoot(root, { report, location }) {
       if (!root.servers || root.servers.length === 0) return;
@@ -25,16 +25,17 @@ export const NoEmptyEnumServers: Oas3Rule = () => {
         invalidVariables.push(...enumErrors);
       }
 
-      for(const invalidVariable of invalidVariables) {
-        if(invalidVariable === enumError.empty) {
+      for (const invalidVariable of invalidVariables) {
+        if (invalidVariable === enumError.empty) {
           report({
             message: 'Server variable with `enum` must be a non-empty array.',
             location: location.child(['servers']).key(),
           });
         }
-        if(invalidVariable === enumError.invalidDefaultValue) {
+        if (invalidVariable === enumError.invalidDefaultValue) {
           report({
-            message: 'Server variable define `enum` and `default`. `enum` must include default value',
+            message:
+              'Server variable define `enum` and `default`. `enum` must include default value',
             location: location.child(['servers']).key(),
           });
         }
@@ -43,20 +44,18 @@ export const NoEmptyEnumServers: Oas3Rule = () => {
   };
 };
 
-function checkEnumVariables(server: Oas3Server): enumError[] | undefined{
-  if (server.variables && Object.keys(server.variables).length === 0)
-    return;
+function checkEnumVariables(server: Oas3Server): enumError[] | undefined {
+  if (server.variables && Object.keys(server.variables).length === 0) return;
 
   const errors: enumError[] = [];
-  for(var variable in server.variables) {
+  for (const variable in server.variables) {
     const serverVariable = server.variables[variable];
     if (!serverVariable.enum) continue;
 
     if (Array.isArray(serverVariable.enum) && serverVariable.enum?.length === 0)
       errors.push(enumError.empty);
 
-    if (!serverVariable.default)
-      continue;
+    if (!serverVariable.default) continue;
 
     const defaultValue = server.variables[variable].default;
     if (serverVariable.enum && !serverVariable.enum.includes(defaultValue))

package/src/rules/oas3/no-unused-components.ts

@@ -2,7 +2,7 @@ import { Oas3Rule } from '../../visitors';
 import { Location } from '../../ref-utils';
 
 export const NoUnusedComponents: Oas3Rule = () => {
-  let components = new Map<string, { used: boolean; location: Location; name: string }>();
+  const components = new Map<string, { used: boolean; location: Location; name: string }>();
 
   function registerComponent(location: Location, name: string): void {
     components.set(location.absolutePointer, {

package/src/rules/oas3/remove-unused-components.ts

@@ -1,12 +1,19 @@
 import { Oas3Rule } from '../../visitors';
 import { Location } from '../../ref-utils';
-import { Oas3Components } from '../../typings/openapi'
+import { Oas3Components } from '../../typings/openapi';
 import { isEmptyObject } from '../../utils';
 
 export const RemoveUnusedComponents: Oas3Rule = () => {
-  let components = new Map<string, { used: boolean; componentType?: keyof Oas3Components; name: string }>();
+  const components = new Map<
+    string,
+    { used: boolean; componentType?: keyof Oas3Components; name: string }
+  >();
 
-  function registerComponent(location: Location, componentType: keyof Oas3Components, name: string): void {
+  function registerComponent(
+    location: Location,
+    componentType: keyof Oas3Components,
+    name: string
+  ): void {
     components.set(location.absolutePointer, {
       used: components.get(location.absolutePointer)?.used || false,
       componentType,
@@ -18,7 +25,9 @@ export const RemoveUnusedComponents: Oas3Rule = () => {
     ref: {
       leave(ref, { type, resolve, key }) {
         if (
-          ['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(type.name)
+          ['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(
+            type.name
+          )
         ) {
           const resolvedRef = resolve(ref);
           if (!resolvedRef.location) return;
@@ -27,25 +36,27 @@ export const RemoveUnusedComponents: Oas3Rule = () => {
             name: key.toString(),
           });
         }
-      }
+      },
     },
     DefinitionRoot: {
       leave(root, ctx) {
         const data = ctx.getVisitorData() as { removedCount: number };
         data.removedCount = 0;
 
-        components.forEach(usageInfo => {
+        components.forEach((usageInfo) => {
           const { used, componentType, name } = usageInfo;
-          if (!used && componentType) {
-            let componentChild = root.components![componentType];
+          if (!used && componentType && root.components) {
+            const componentChild = root.components[componentType];
             delete componentChild![name];
             data.removedCount++;
             if (isEmptyObject(componentChild)) {
-              delete root.components![componentType];
+              delete root.components[componentType];
             }
           }
         });
-        if (isEmptyObject(root.components)) { delete root.components; }
+        if (isEmptyObject(root.components)) {
+          delete root.components;
+        }
       },
     },
     NamedSchemas: {