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

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,

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

@@ -4,9 +4,16 @@ import { Oas2Components } from '../../typings/swagger';
 import { isEmptyObject } from '../../utils';
 
 export const RemoveUnusedComponents: Oas2Rule = () => {
-  let components = new Map<string, { used: boolean; componentType?: keyof Oas2Components; name: string }>();
+  const components = new Map<
+    string,
+    { used: boolean; componentType?: keyof Oas2Components; name: string }
+  >();
 
-  function registerComponent(location: Location, componentType: keyof Oas2Components, name: string): void {
+  function registerComponent(
+    location: Location,
+    componentType: keyof Oas2Components,
+    name: string
+  ): void {
     components.set(location.absolutePointer, {
       used: components.get(location.absolutePointer)?.used || false,
       componentType,
@@ -17,9 +24,7 @@ export const RemoveUnusedComponents: Oas2Rule = () => {
   return {
     ref: {
       leave(ref, { type, resolve, key }) {
-        if (
-          ['Schema', 'Parameter', 'Response', 'SecurityScheme'].includes(type.name)
-        ) {
+        if (['Schema', 'Parameter', 'Response', 'SecurityScheme'].includes(type.name)) {
           const resolvedRef = resolve(ref);
           if (!resolvedRef.location) return;
           components.set(resolvedRef.location.absolutePointer, {
@@ -27,15 +32,15 @@ export const RemoveUnusedComponents: Oas2Rule = () => {
             name: key.toString(),
           });
         }
-      }
+      },
     },
     DefinitionRoot: {
       leave(root, ctx) {
         const data = ctx.getVisitorData() as { removedCount: number };
         data.removedCount = 0;
 
-        let rootComponents = new Set<keyof Oas2Components>();
-        components.forEach(usageInfo => {
+        const rootComponents = new Set<keyof Oas2Components>();
+        components.forEach((usageInfo) => {
           const { used, name, componentType } = usageInfo;
           if (!used && componentType) {
             rootComponents.add(componentType);
@@ -71,6 +76,6 @@ export const RemoveUnusedComponents: Oas2Rule = () => {
       SecurityScheme(_securityScheme, { location, key }) {
         registerComponent(location, 'securityDefinitions', key.toString());
       },
-    }
+    },
   };
 };

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

@@ -16,7 +16,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               schema:
                 type: boolean
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -68,7 +68,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
                   schema:
                     type: boolean
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -92,7 +92,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
                 schema:
                   type: boolean
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

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

@@ -3,8 +3,8 @@ import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
-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 () => {
+describe('Oas3 as3-no-server-variables-empty-enum', () => {
+  it('oas3-no-server-variables-empty-enum: should report on server object with empty enum and unknown enum value', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -24,7 +24,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -38,7 +38,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
             },
           ],
           "message": "Server variable with \`enum\` must be a non-empty array.",
-          "ruleId": "no-servers-empty-enum",
+          "ruleId": "no-server-variables-empty-enum",
           "severity": "error",
           "suggest": Array [],
         },
@@ -51,7 +51,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
             },
           ],
           "message": "Server variable define \`enum\` and \`default\`. \`enum\` must include default value",
-          "ruleId": "no-servers-empty-enum",
+          "ruleId": "no-server-variables-empty-enum",
           "severity": "error",
           "suggest": Array [],
         },
@@ -59,7 +59,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     `);
   });
 
-  it('oas3-no-servers-empty-enum: should report on server object with empty enum', async () => {
+  it('oas3-no-server-variables-empty-enum: should report on server object with empty enum', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -78,7 +78,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -92,7 +92,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
             },
           ],
           "message": "Server variable with \`enum\` must be a non-empty array.",
-          "ruleId": "no-servers-empty-enum",
+          "ruleId": "no-server-variables-empty-enum",
           "severity": "error",
           "suggest": Array [],
         },
@@ -100,7 +100,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     `);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because variables is empty object', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because variables is empty object', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -117,13 +117,13 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because variable is empty object', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because variable is empty object', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -141,13 +141,13 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because enum contains default value', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because enum contains default value', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -168,13 +168,13 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because enum contains default value', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because enum contains default value', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -197,7 +197,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

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

@@ -14,7 +14,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
                 value: 12
                 externalValue: https://1.1.1.1
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -51,7 +51,7 @@ describe('Oas3 oas3-no-example-value-and-externalValue', () => {
               some:
                 value: 12
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

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

@@ -27,7 +27,7 @@ describe('no-invalid-media-type-examples', () => {
                             type: number
 
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -76,7 +76,7 @@ describe('no-invalid-media-type-examples', () => {
     `);
   });
 
-  it('should report on invalid example with disallowAdditionalProperties', async () => {
+  it('should report on invalid example with allowAdditionalProperties', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -100,7 +100,7 @@ describe('no-invalid-media-type-examples', () => {
                             type: number
 
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -109,7 +109,7 @@ describe('no-invalid-media-type-examples', () => {
       config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
-          disallowAdditionalProperties: true,
+          allowAdditionalProperties: false,
         },
       }),
     });
@@ -137,7 +137,7 @@ describe('no-invalid-media-type-examples', () => {
     `);
   });
 
-  it('should not on invalid example with disallowAdditionalProperties', async () => {
+  it('should not on invalid example with allowAdditionalProperties', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -160,7 +160,7 @@ describe('no-invalid-media-type-examples', () => {
                             type: number
 
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -169,7 +169,7 @@ describe('no-invalid-media-type-examples', () => {
       config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
-          disallowAdditionalProperties: true,
+          allowAdditionalProperties: false,
         },
       }),
     });
@@ -210,7 +210,7 @@ describe('no-invalid-media-type-examples', () => {
                             type: number
 
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -219,7 +219,7 @@ describe('no-invalid-media-type-examples', () => {
       config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
-          disallowAdditionalProperties: true,
+          allowAdditionalProperties: false,
         },
       }),
     });
@@ -263,7 +263,7 @@ describe('no-invalid-media-type-examples', () => {
                         b: 35
 
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -295,7 +295,7 @@ describe('no-invalid-media-type-examples', () => {
                             type: number
 
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -330,7 +330,7 @@ describe('no-invalid-media-type-examples', () => {
                         $ref: '#/components/schemas/C'
 
       `,
-      __dirname + '/foobar.yaml',
+      __dirname + '/foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -358,7 +358,7 @@ describe('no-invalid-media-type-examples', () => {
                         nullable: true
 
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

package/src/rules/oas3/__tests__/no-server-example.com.test.ts

@@ -11,7 +11,7 @@ describe('Oas3 oas3-no-server-example.com', () => {
           servers:
             - url: example.com
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -46,7 +46,7 @@ describe('Oas3 oas3-no-server-example.com', () => {
           servers:
             - url: not-example.com
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts

@@ -11,7 +11,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
           servers:
             - url: https://somedomain.com/
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -46,7 +46,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
           servers:
             - url: https://somedomain.com
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -65,7 +65,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
           servers:
             - url: /
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

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

@@ -36,7 +36,7 @@ describe('Oas3 no-unused-components', () => {
                 - 1
                 - 2
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

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

@@ -36,6 +36,6 @@ it('should not fail on valid callbacks object', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`Array []`);
 });

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

@@ -23,7 +23,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -56,7 +56,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -89,7 +89,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -126,7 +126,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -155,7 +155,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -191,7 +191,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -226,7 +226,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -253,7 +253,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -288,7 +288,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -322,7 +322,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`Array []`);
   });
 
@@ -346,7 +346,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {
@@ -378,7 +378,7 @@ describe('OpenAPI Schema', () => {
     expect(
       await validateDoc(source, {
         spec: 'error',
-      }),
+      })
     ).toMatchInlineSnapshot(`
       Array [
         Object {

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

@@ -23,7 +23,7 @@ it('should not report if summary field is valid', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`Array []`);
 });
 
@@ -49,7 +49,7 @@ it('should report if summary field is not string ', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`
     Array [
       Object {
@@ -82,7 +82,7 @@ it('should not report if description field is valid', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`Array []`);
 });
 
@@ -108,7 +108,7 @@ it('should report if description field is not string', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`
     Array [
       Object {
@@ -140,7 +140,7 @@ it('should not report of a valid GET operation object', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`Array []`);
 });
 
@@ -170,7 +170,7 @@ it('should not report of a valid PUT operation object', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`Array []`);
 });
 
@@ -208,7 +208,7 @@ it('should not report of a valid Post operation object', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`Array []`);
 });
 
@@ -248,6 +248,6 @@ it('should not report of a valid delete operation object', async () => {
   expect(
     await validateDoc(source, {
       spec: 'error',
-    }),
+    })
   ).toMatchInlineSnapshot(`Array []`);
 });