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

package/src/__tests__/lint.test.ts

@@ -12,16 +12,16 @@ describe('lint', () => {
     const results = await lintFromString({
       absoluteRef: '/test/spec.yaml',
       source: outdent`
-      openapi: 3.0.0
-      info:
-        title: Test API
-        version: "1.0"
-        description: Test
-        license: Fail
+        openapi: 3.0.0
+        info:
+          title: Test API
+          version: "1.0"
+          description: Test
+          license: Fail
 
-      servers:
-        - url: http://example.com
-      paths: {}
+        servers:
+          - url: http://example.com
+        paths: {}
     `,
       config: await loadConfig(),
     });
@@ -29,6 +29,7 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/info/license",
@@ -48,8 +49,7 @@ describe('lint', () => {
   it('lintConfig should work', async () => {
     const document = parseYamlToDocument(
       outdent`
-      apis: error string
-      styleguide:
+        apis: error string
         plugins:
           - './local-plugin.js'
         extends:
@@ -60,6 +60,12 @@ describe('lint', () => {
           no-invalid-media-type-examples: error
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
+          assert/operation-summary-length:
+            subject: Operation
+            property: summary
+            message: Operation summary should start with an active verb
+            local/checkWordsCount: 
+              min: 3
       features.openapi:
         showConsole: true
         layout:
@@ -70,6 +76,16 @@ describe('lint', () => {
             backgroundColor: '#263238'
           links:
             color: '#6CC496'
+        features.openapi:
+          showConsole: true
+          layout:
+            scope: section
+          routingStrategy: browser
+          theme:
+            rightPanel:
+              backgroundColor: '#263238'
+            links:
+              color: '#6CC496'
       `,
       ''
     );
@@ -78,6 +94,79 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/atures.openapi",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`atures.openapi\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [
+            "features.openapi",
+          ],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/showConsole",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`showConsole\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/layout",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`layout\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/routingStrategy",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`routingStrategy\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/theme",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`theme\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/apis",
@@ -91,6 +180,7 @@ describe('lint', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/features.openapi/layout",
@@ -110,10 +200,9 @@ describe('lint', () => {
   it('lintConfig should detect wrong fields and suggest correct ones', async () => {
     const document = parseYamlToDocument(
       outdent`
-      api: 
-        name@version:
-          root: ./file.yaml
-      syleguide:
+        api:
+          name@version:
+            root: ./file.yaml
         rules:
           operation-2xx-response: warn
       `,
@@ -124,6 +213,7 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/api",
@@ -138,21 +228,6 @@ describe('lint', () => {
             "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",
-          ],
-        },
       ]
     `);
   });
@@ -160,13 +235,13 @@ describe('lint', () => {
   it('lintConfig should work with legacy fields', async () => {
     const document = parseYamlToDocument(
       outdent`
-      apiDefinitions: 
-        entry: ./file.yaml
-      lint:
+        apis: 
+          entry: 
+            root: ./file.yaml
         rules:
           operation-2xx-response: warn
-      referenceDocs:
-        showConsole: true
+        referenceDocs:
+          showConsole: true
       `,
       ''
     );
@@ -175,16 +250,16 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it("'plugins' shouldn't be allowed in 'apis' -> 'styleguide' field", async () => {
+  it("'plugins' shouldn't be allowed in 'apis'", async () => {
     const document = parseYamlToDocument(
       outdent`
-      apis: 
-        styleguide: 
-          plugins: 
+        apis:
+          main:
+            root: ./main.yaml
+            plugins:
             - './local-plugin.js'
-      styleguide:
         plugins:
-          - './local-plugin.js'
+        - './local-plugin.js'
       `,
       ''
     );
@@ -193,22 +268,10 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
-              "pointer": "#/apis/styleguide",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "The field \`root\` must be present on this level.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/apis/styleguide/plugins",
+              "pointer": "#/apis/main/plugins",
               "reportOnKey": true,
               "source": "",
             },
@@ -225,31 +288,31 @@ describe('lint', () => {
   it("'const' can have any type", async () => {
     const document = parseYamlToDocument(
       outdent`
-      openapi: "3.1.0"
-      info:
-        version: 1.0.0
-        title: Swagger Petstore
-        description: Information about Petstore
-        license:
-          name: MIT
-          url: https://opensource.org/licenses/MIT
-      servers:
-        - url: http://petstore.swagger.io/v1
-      paths:
-        /pets:
-          get:
-            summary: List all pets
-            operationId: listPets
-            tags:
-              - pets
-            responses:
-              200:
-                description: An paged array of pets
-                content:
-                  application/json:
-                    schema:
-                      type: string
-                      const: ABC
+        openapi: "3.1.0"
+        info:
+          version: 1.0.0
+          title: Swagger Petstore
+          description: Information about Petstore
+          license:
+            name: MIT
+            url: https://opensource.org/licenses/MIT
+        servers:
+          - url: http://petstore.swagger.io/v1
+        paths:
+          /pets:
+            get:
+              summary: List all pets
+              operationId: listPets
+              tags:
+                - pets
+              responses:
+                200:
+                  description: An paged array of pets
+                  content:
+                    application/json:
+                      schema:
+                        type: string
+                        const: ABC
         `,
       'foobar.yaml'
     );
@@ -266,8 +329,8 @@ describe('lint', () => {
   it('detect OpenAPI should throw an error when version is not string', () => {
     const testDocument = parseYamlToDocument(
       outdent`
-      openapi: 3.0
-    `,
+        openapi: 3.0
+      `,
       ''
     );
     expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
@@ -278,28 +341,28 @@ describe('lint', () => {
   it("spec rule shouldn't throw an error for named callback", async () => {
     const document = parseYamlToDocument(
       outdent`
-      openapi: 3.1.0
-      info:
-        title: Callback test
-        version: 'alpha'
-      components:
-        callbacks:
-          resultCallback:
-            '{$url}':
-              post:
-                requestBody:
-                  description: Callback payload
-                  content:
-                    'application/json':
-                      schema:
-                        type: object
-                        properties:
-                          test:
-                            type: string
-                responses:
-                  '200':
-                    description: callback successfully processed
-    `,
+        openapi: 3.1.0
+        info:
+          title: Callback test
+          version: 'alpha'
+        components:
+          callbacks:
+            resultCallback:
+              '{$url}':
+                post:
+                  requestBody:
+                    description: Callback payload
+                    content:
+                      'application/json':
+                        schema:
+                          type: object
+                          properties:
+                            test:
+                              type: string
+                  responses:
+                    '200':
+                      description: callback successfully processed
+      `,
       'foobar.yaml'
     );
 
@@ -316,23 +379,23 @@ describe('lint', () => {
     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
+        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
     );

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

@@ -43,7 +43,7 @@ describe('Resolve http-headers', () => {
           ],
         },
       }),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(fetchMock).toBeCalledTimes(3);

package/src/__tests__/resolve.test.ts

@@ -24,7 +24,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -63,7 +63,7 @@ describe('collect refs', () => {
       await resolveDocument({
         rootDocument,
         externalRefResolver: new BaseResolver(),
-        rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+        rootType: normalizeTypes(Oas3Types).Root,
       });
     } catch (e) {
       expect(e.message).toEqual('Self-referencing circular pointer');
@@ -95,7 +95,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -132,7 +132,7 @@ describe('collect refs', () => {
       await resolveDocument({
         rootDocument,
         externalRefResolver: new BaseResolver(),
-        rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+        rootType: normalizeTypes(Oas3Types).Root,
       });
     } catch (e) {
       expect(e.message).toEqual('Self-referencing circular pointer');
@@ -153,7 +153,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -187,7 +187,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument: rootDocument as Document,
       externalRefResolver: externalRefResolver,
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -263,7 +263,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument: rootDocument as Document,
       externalRefResolver: externalRefResolver,
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -358,7 +358,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument: rootDocument as Document,
       externalRefResolver: externalRefResolver,
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -392,7 +392,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();

package/src/__tests__/walk.test.ts

@@ -16,7 +16,7 @@ import { Oas3RuleSet } from '../oas-types';
 describe('walk order', () => {
   it('should run visitors', async () => {
     const visitors = {
-      DefinitionRoot: {
+      Root: {
         enter: jest.fn(),
         leave: jest.fn(),
       },
@@ -63,6 +63,74 @@ describe('walk order', () => {
     }
   });
 
+  it('should run legacy visitors', async () => {
+    const visitors = {
+      DefinitionRoot: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      PathMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      ServerVariableMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      MediaTypeMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      ExampleMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      HeaderMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+    };
+
+    const testRuleSet: Oas3RuleSet = {
+      test: jest.fn(() => {
+        return visitors;
+      }),
+    };
+
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        servers: 
+        - url: http://{test}.url
+          variables:
+            test: test
+        paths: 
+          /test-path: 
+            get:
+              responses:
+                200:
+                  headers: {}
+                  content:
+                    application/json:
+                      schema: {}
+                      examples: {}
+      `,
+      ''
+    );
+
+    await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: makeConfigForRuleset(testRuleSet),
+    });
+
+    expect(testRuleSet.test).toBeCalledTimes(1);
+    for (const fns of Object.values(visitors)) {
+      expect(fns.enter).toBeCalled();
+      expect(fns.leave).toBeCalled();
+    }
+  });
+
   it('should run nested visitors correctly', async () => {
     const calls: string[] = [];
 
@@ -1046,8 +1114,8 @@ describe('walk order', () => {
 
     expect(calls).toMatchInlineSnapshot(`
       Array [
-        "enter DefinitionRoot",
-        "enter PathMap",
+        "enter Root",
+        "enter PathsMap",
         "enter PathItem",
         "enter ParameterList",
         "enter Parameter",
@@ -1066,7 +1134,7 @@ describe('walk order', () => {
         "leave ParameterList",
         "leave Operation",
         "leave PathItem",
-        "leave PathMap",
+        "leave PathsMap",
         "enter Components",
         "enter NamedParameters",
         "leave NamedParameters",
@@ -1075,7 +1143,7 @@ describe('walk order', () => {
         "leave Schema",
         "leave NamedSchemas",
         "leave Components",
-        "leave DefinitionRoot",
+        "leave Root",
       ]
     `);
   });
@@ -1378,10 +1446,10 @@ describe('type extensions', () => {
                   parameters: listOf('Parameter'),
                 },
               },
-              DefinitionRoot: {
-                ...types.DefinitionRoot,
+              Root: {
+                ...types.Root,
                 properties: {
-                  ...types.DefinitionRoot.properties,
+                  ...types.Root.properties,
                   'x-webhooks': 'XWebHooks',
                 },
               },
@@ -1393,7 +1461,7 @@ describe('type extensions', () => {
 
     expect(calls).toMatchInlineSnapshot(`
       Array [
-        "enter DefinitionRoot",
+        "enter Root",
         "enter XWebHooks",
         "enter hook test",
         "enter ParameterList",
@@ -1402,7 +1470,7 @@ describe('type extensions', () => {
         "leave ParameterList",
         "leave hook test",
         "leave XWebHooks",
-        "leave DefinitionRoot",
+        "leave Root",
       ]
     `);
   });

package/src/benchmark/benches/resolve-with-no-external.bench.ts

@@ -18,6 +18,6 @@ export function measureAsync() {
   return resolveDocument({
     rootDocument: rebillyDocument,
     externalRefResolver,
-    rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+    rootType: normalizeTypes(Oas3Types).Root,
   });
 }