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

package/src/__tests__/bundle.test.ts

@@ -2,11 +2,21 @@ import outdent from 'outdent';
 import * as path from 'path';
 
 import { bundleDocument, bundle } from '../bundle';
-import { parseYamlToDocument, yamlSerializer } from '../../__tests__/utils';
-import { LintConfig, Config, ResolvedConfig } from '../config';
+import { parseYamlToDocument, yamlSerializer, makeConfig } from '../../__tests__/utils';
+import { StyleguideConfig, Config, ResolvedConfig } from '../config';
 import { BaseResolver } from '../resolve';
 
 describe('bundle', () => {
+  const fetchMock = jest.fn(() =>
+    Promise.resolve({
+      ok: true,
+      text: () => 'External schema content',
+      headers: {
+        get: () => '',
+      },
+    })
+  );
+
   expect.addSnapshotSerializer(yamlSerializer);
 
   const testDocument = parseYamlToDocument(
@@ -28,14 +38,14 @@ describe('bundle', () => {
           shared_a:
             name: shared-a
     `,
-    '',
+    ''
   );
 
   it('change nothing with only internal refs', async () => {
     const { bundle, problems } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
+      config: new StyleguideConfig({}),
     });
 
     const origCopy = JSON.parse(JSON.stringify(testDocument.parsed));
@@ -60,7 +70,7 @@ describe('bundle', () => {
     });
     expect(problems).toHaveLength(1);
     expect(problems[0].message).toEqual(
-      `Two schemas are referenced with the same name but different content. Renamed param-b to param-b-2.`,
+      `Two schemas are referenced with the same name but different content. Renamed param-b to param-b-2.`
     );
     expect(res.parsed).toMatchSnapshot();
   });
@@ -68,7 +78,7 @@ describe('bundle', () => {
   it('should dereferenced correctly when used with dereference', async () => {
     const { bundle: res, problems } = await bundleDocument({
       externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
+      config: new StyleguideConfig({}),
       document: testDocument,
       dereference: true,
     });
@@ -98,47 +108,25 @@ describe('bundle', () => {
   });
 
   it('should pull hosted schema', async () => {
-    const fetchMock = jest.fn(
-      () => Promise.resolve({
-        ok: true,
-        text: () => 'External schema content',
-        headers: {
-          get: () => ''
-        }
-      })
-    );
-
     const { bundle: res, problems } = await bundle({
       config: new Config({} as ResolvedConfig),
       externalRefResolver: new BaseResolver({
         http: {
           customFetch: fetchMock,
-          headers: []
-        }
+          headers: [],
+        },
       }),
-      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml')
+      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml'),
     });
 
     expect(problems).toHaveLength(0);
-    expect(fetchMock).toHaveBeenCalledWith(
-      "https://someexternal.schema",
-      {
-        headers: {}
-      }
-    );
+    expect(fetchMock).toHaveBeenCalledWith('https://someexternal.schema', {
+      headers: {},
+    });
     expect(res.parsed).toMatchSnapshot();
   });
 
   it('should not bundle url refs if used with keepUrlRefs', async () => {
-    const fetchMock = jest.fn(() =>
-        Promise.resolve({
-          ok: true,
-          text: () => 'External schema content',
-          headers: {
-            get: () => '',
-          },
-        }),
-    );
     const { bundle: res, problems } = await bundle({
       config: new Config({} as ResolvedConfig),
       externalRefResolver: new BaseResolver({
@@ -153,4 +141,50 @@ describe('bundle', () => {
     expect(problems).toHaveLength(0);
     expect(res.parsed).toMatchSnapshot();
   });
+
+  it('should add to meta ref from redocly registry', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            get:
+              operationId: get
+              parameters:
+                - $ref: '#/components/parameters/shared_a'
+                - name: get_b
+            post:
+              operationId: post
+              parameters:
+                - $ref: 'https://api.redocly.com/registry/params'
+        components:
+          parameters:
+            shared_a:
+              name: shared-a
+      `,
+      ''
+    );
+
+    const config = await makeConfig({}, { 'registry-dependencies': 'on' });
+
+    const {
+      bundle: result,
+      problems,
+      ...meta
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver({
+        http: {
+          customFetch: fetchMock,
+          headers: [],
+        },
+      }),
+    });
+
+    const parsedMeta = JSON.parse(JSON.stringify(meta));
+
+    expect(problems).toHaveLength(0);
+    expect(parsedMeta).toMatchSnapshot();
+  });
 });

package/src/__tests__/codeframes.test.ts

@@ -17,7 +17,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -37,7 +37,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -57,7 +57,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -77,7 +77,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -98,7 +98,7 @@ describe('Location', () => {
             license:
               name: MIT
               url: https://google.com
-        `,
+        `
       ),
     };
     const preciseLocation = getLineColLocation(loc);
@@ -106,7 +106,6 @@ describe('Location', () => {
     expect(preciseLocation.end).toEqual({ line: 2, col: 9 });
   });
 
-
   it('should return first line for empty doc', () => {
     const loc = {
       reportOnKey: false,
@@ -158,7 +157,7 @@ describe('codeframes', () => {
             license:
               name: MIT
               url: https://google.com
-            `,
+            `
       ),
     };
 
@@ -222,7 +221,7 @@ describe('codeframes', () => {
             license:
               name: MIT
               url: https://google.com
-            `,
+            `
       ),
     };
 
@@ -256,7 +255,7 @@ describe('codeframes', () => {
               name: MIT,
               url: https://google.com
             }
-            `,
+            `
       ),
     };
 
@@ -299,7 +298,7 @@ describe('codeframes', () => {
               field5: MIT
               url: https://google.com
           openapi: 3.0.2
-          `,
+          `
       ),
     };
 
@@ -343,7 +342,7 @@ describe('codeframes', () => {
               field3: MIT
               field4: MIT
               field5: MIT
-          `,
+          `
       ),
     };
 
@@ -390,7 +389,7 @@ describe('codeframes', () => {
                     in: wrong
               post:
                 operationId: test2
-          `,
+          `
       ),
     };
 
@@ -425,7 +424,7 @@ describe('codeframes', () => {
             license:
               name: MIT
               url: https://google.com
-          `,
+          `
       ),
     };
 
@@ -483,7 +482,7 @@ describe('codeframes', () => {
           license:
             name: MIT
             url: https://google.com
-      `,
+      `
       ),
     };
 

package/src/__tests__/fixtures/.redocly.lint-ignore.yaml

@@ -0,0 +1,5 @@
+# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
+# See https://redoc.ly/docs/cli/ for more information.
+openapi.yaml:
+  operation-operationId:
+    - '#/paths/~1pets~1{petId}/post/operationId'

package/src/__tests__/js-yaml.test.ts

@@ -48,7 +48,7 @@ describe('js-yaml', () => {
 
   test('should correctly dump date and string', () => {
     expect(stringifyYaml(parseYaml(yamlToDump))).toMatchInlineSnapshot(
-    `
+      `
     "date: '2022-01-21T11:29:56.694Z'
     dateWithoutQuotes: '2020-01-01'
     dateWithQuotes: '2020-01-01'
@@ -57,7 +57,8 @@ describe('js-yaml', () => {
     stringWithQuotes: test
     stringWithDoubleQuotes: test
     "
-    `);
+    `
+    );
   });
 
   test('parse and stringify', () => {
@@ -65,7 +66,8 @@ describe('js-yaml', () => {
   });
 
   test('should throw an error for unsupported types', () => {
-    expect(() => stringifyYaml({ foo: () => {} }))
-      .toThrow('unacceptable kind of an object to dump [object Function]');
+    expect(() => stringifyYaml({ foo: () => {} })).toThrow(
+      'unacceptable kind of an object to dump [object Function]'
+    );
   });
 });

package/src/__tests__/lint.test.ts

@@ -1,3 +1,4 @@
+import * as path from 'path';
 import { outdent } from 'outdent';
 
 import { lintFromString, lintConfig, lintDocument } from '../lint';
@@ -48,7 +49,7 @@ describe('lint', () => {
     const document = parseYamlToDocument(
       outdent`
       apis: error string
-      lint:
+      styleguide:
         plugins:
           - './local-plugin.js'
         extends:
@@ -70,7 +71,7 @@ describe('lint', () => {
           links:
             color: '#6CC496'
       `,
-      '',
+      ''
     );
     const results = await lintConfig({ document });
 
@@ -106,18 +107,86 @@ describe('lint', () => {
     `);
   });
 
-  it("'plugins' shouldn't be allowed in 'apis' -> 'lint' field", async () => {
+  it('lintConfig should detect wrong fields and suggest correct ones', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      api: 
+        name@version:
+          root: ./file.yaml
+      syleguide:
+        rules:
+          operation-2xx-response: warn
+      `,
+      ''
+    );
+    const results = await lintConfig({ document });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/api",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`api\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [
+            "apis",
+          ],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/syleguide",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`syleguide\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [
+            "styleguide",
+          ],
+        },
+      ]
+    `);
+  });
+
+  it('lintConfig should work with legacy fields', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      apiDefinitions: 
+        entry: ./file.yaml
+      lint:
+        rules:
+          operation-2xx-response: warn
+      referenceDocs:
+        showConsole: true
+      `,
+      ''
+    );
+    const results = await lintConfig({ document });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it("'plugins' shouldn't be allowed in 'apis' -> 'styleguide' field", async () => {
     const document = parseYamlToDocument(
       outdent`
       apis: 
-        lint: 
+        styleguide: 
           plugins: 
             - './local-plugin.js'
-      lint:
+      styleguide:
         plugins:
           - './local-plugin.js'
       `,
-      '',
+      ''
     );
     const results = await lintConfig({ document });
 
@@ -126,7 +195,7 @@ describe('lint', () => {
         Object {
           "location": Array [
             Object {
-              "pointer": "#/apis/lint",
+              "pointer": "#/apis/styleguide",
               "reportOnKey": true,
               "source": "",
             },
@@ -139,7 +208,7 @@ describe('lint', () => {
         Object {
           "location": Array [
             Object {
-              "pointer": "#/apis/lint/plugins",
+              "pointer": "#/apis/styleguide/plugins",
               "reportOnKey": true,
               "source": "",
             },
@@ -182,7 +251,7 @@ describe('lint', () => {
                       type: string
                       const: ABC
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -199,10 +268,10 @@ describe('lint', () => {
       outdent`
       openapi: 3.0
     `,
-      '',
+      ''
     );
     expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
-      `Invalid OpenAPI version: should be a string but got "number"`,
+      `Invalid OpenAPI version: should be a string but got "number"`
     );
   });
 
@@ -231,7 +300,7 @@ describe('lint', () => {
                   '200':
                     description: callback successfully processed
     `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -242,4 +311,50 @@ describe('lint', () => {
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
+
+  it('should ignore error because ignore file passed', async () => {
+    const absoluteRef = path.join(__dirname, 'fixtures/openapi.yaml');
+    const document = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      info:
+        version: 1.0.0
+        title: Example OpenAPI 3 definition.
+        description: Information about API
+        license:
+          name: MIT
+          url: 'https://opensource.org/licenses/MIT'
+      servers:
+        - url: 'https://redocly.com/v1'
+      paths:
+        '/pets/{petId}':
+          post:
+            responses:
+              '201':
+                summary: Exist 
+                description: example description
+      `,
+      absoluteRef
+    );
+
+    const configFilePath = path.join(__dirname, 'fixtures');
+
+    const result = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'operation-operationId': 'error' }, undefined, configFilePath),
+    });
+    expect(result).toHaveLength(1);
+    expect(result).toMatchObject([
+      {
+        ignored: true,
+        location: [{ pointer: '#/paths/~1pets~1{petId}/post/operationId' }],
+        message: 'Operation object should contain `operationId` field.',
+        ruleId: 'operation-operationId',
+        severity: 'error',
+      },
+    ]);
+    expect(result[0]).toHaveProperty('ignored', true);
+    expect(result[0]).toHaveProperty('ruleId', 'operation-operationId');
+  });
 });

package/src/__tests__/login.test.ts

@@ -6,10 +6,10 @@ describe.skip('login', () => {
     Object.defineProperty(client, 'registryApi', {
       value: {
         setAccessTokens: jest.fn(),
-        authStatus: jest.fn(() => true)
+        authStatus: jest.fn(() => true),
       },
       writable: true,
-      configurable: true
+      configurable: true,
     });
     await client.login('token'); // TODO: bug with rewrite local config file
     expect(client.registryApi.setAccessTokens).toHaveBeenCalled();

package/src/__tests__/normalizeVisitors.test.ts

@@ -22,7 +22,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
@@ -66,7 +66,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
@@ -104,7 +104,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
@@ -139,7 +139,7 @@ describe('Normalize visitors', () => {
         ruleId,
         severity: 'error' as 'error',
         visitor: ruleset[ruleId]({}),
-      })),
+      }))
     );
 
     const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));

package/src/__tests__/ref-utils.test.ts

@@ -2,7 +2,7 @@ import outdent from 'outdent';
 import { parseYamlToDocument } from '../../__tests__/utils';
 import { parseRef, refBaseName } from '../ref-utils';
 import { lintDocument } from '../lint';
-import { LintConfig } from '../config';
+import { StyleguideConfig } from '../config';
 import { BaseResolver } from '../resolve';
 
 describe('ref-utils', () => {
@@ -84,37 +84,37 @@ describe('ref-utils', () => {
                 name:
                   type: string
       `,
-      '',
+      ''
     );
 
     const result = await lintDocument({
       document,
       externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
+      config: new StyleguideConfig({}),
     });
 
     expect(result).toMatchInlineSnapshot(`Array []`);
   });
 
   describe('refBaseName', () => {
-    it("returns base name for file reference", () => {
-      expect(refBaseName("../testcase/Pet.yaml")).toStrictEqual("Pet");
+    it('returns base name for file reference', () => {
+      expect(refBaseName('../testcase/Pet.yaml')).toStrictEqual('Pet');
     });
 
-    it("returns base name for local file reference", () => {
-      expect(refBaseName("Cat.json")).toStrictEqual("Cat");
+    it('returns base name for local file reference', () => {
+      expect(refBaseName('Cat.json')).toStrictEqual('Cat');
     });
 
-    it("returns base name for url reference", () => {
-      expect(refBaseName("http://example.com/tests/crocodile.json")).toStrictEqual("crocodile");
+    it('returns base name for url reference', () => {
+      expect(refBaseName('http://example.com/tests/crocodile.json')).toStrictEqual('crocodile');
     });
 
-    it("returns base name for file with multiple dots in name", () => {
-      expect(refBaseName("feline.tiger.v1.yaml")).toStrictEqual("feline.tiger.v1");
+    it('returns base name for file with multiple dots in name', () => {
+      expect(refBaseName('feline.tiger.v1.yaml')).toStrictEqual('feline.tiger.v1');
     });
 
-    it("returns base name for file without any dots in name", () => {
-      expect(refBaseName("abcdefg")).toStrictEqual("abcdefg");
+    it('returns base name for file without any dots in name', () => {
+      expect(refBaseName('abcdefg')).toStrictEqual('abcdefg');
     });
   });
 });

package/src/__tests__/resolve-http.test.ts

@@ -19,7 +19,7 @@ describe('Resolve http-headers', () => {
             C:
               $ref: 'https://sample.com/test/a/test.yaml'
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const fetchMock = jest.fn(() => Promise.resolve({ ok: true, text: Promise.resolve('') }));