@redocly/openapi-core 1.34.4 → 2.0.0-next.1

package/src/rules/common/__tests__/license-url.test.ts

@@ -1,63 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 license-url', () => {
-  it('should report on info.license with no url', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          info:
-            license:
-              name: MIT
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'info-license-url': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/info/license/url",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "License object should contain \`url\` field.",
-          "ruleId": "info-license-url",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report on info.license with url', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          info:
-            license:
-              name: MIT
-              url: google.com
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'info-license': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

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

@@ -1,96 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('no-ambiguous-paths', () => {
-  it('should report on ambiguous paths', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          '/good/{id}':
-            get:
-              summary: List all pets
-          '/good/last':
-            get:
-              summary: List all pets
-          '/good/{id}/{pet}':
-            get:
-              summary: List all pets
-          '/good/last/{id}':
-            get:
-              summary: List all pets
-          '/{id}/ambiguous':
-            get:
-              summary: List all pets
-          '/ambiguous/{id}':
-            get:
-              summary: List all pets
-          '/pet/last':
-            get:
-              summary: List all pets
-          '/pet/first':
-            get:
-              summary: List all pets
-          '/{entity}/{id}/last':
-            get:
-              summary: List all pets
-          '/pet/first/{id}':
-            get:
-              summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-ambiguous-paths': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1{id}~1ambiguous",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Paths should resolve unambiguously. Found two ambiguous paths: \`/good/{id}\` and \`/{id}/ambiguous\`.",
-          "ruleId": "no-ambiguous-paths",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1ambiguous~1{id}",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Paths should resolve unambiguously. Found two ambiguous paths: \`/{id}/ambiguous\` and \`/ambiguous/{id}\`.",
-          "ruleId": "no-ambiguous-paths",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1{entity}~1{id}~1last",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Paths should resolve unambiguously. Found two ambiguous paths: \`/good/{id}/{pet}\` and \`/{entity}/{id}/last\`.",
-          "ruleId": "no-ambiguous-paths",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

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

@@ -1,210 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 typed enum', () => {
-  it('should not report on enum object if all items match type', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /some:
-              get:
-                responses:
-                  '200':
-                    description: A paged array of pets
-                    content:
-                      application/json:
-                        schema:
-                          type: integer
-                          enum:
-                            - 1
-                            - 2
-                            - 3
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-enum-type-mismatch': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report on enum object if all items match type and enum is nullable', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /some:
-              get:
-                responses:
-                  '200':
-                    description: A paged array of pets
-                    content:
-                      application/json:
-                        schema:
-                          type: string
-                          nullable: true
-                          enum:
-                            - A
-                            - B
-                            - C
-                            - null
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-enum-type-mismatch': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should report on enum object if not all items match type', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /some:
-              get:
-                responses:
-                  '200':
-                    content:
-                      application/json:
-                        schema:
-                          type: integer
-                          enum:
-                            - 1
-                            - string
-                            - 3
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-enum-type-mismatch': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1some/get/responses/200/content/application~1json/schema/enum/1",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "All values of \`enum\` field must be of the same type as the \`type\` field: expected "integer" but received "string".",
-          "ruleId": "no-enum-type-mismatch",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it("should report on enum object, 'string' value in enum does not have allowed types", async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.1.0
-          paths:
-            /some:
-              get:
-                responses:
-                  '200':
-                    content:
-                      application/json:
-                        schema:
-                          type:
-                            - integer
-                            - array
-                          enum:
-                            - 1
-                            - string
-                            - 3
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-enum-type-mismatch': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1some/get/responses/200/content/application~1json/schema/enum/1",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Enum value \`string\` must be of allowed types: \`integer,array\`.",
-          "ruleId": "no-enum-type-mismatch",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not crash on null schema when there is spec rule', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          info:
-            title: test
-            version: 1.2.3
-          paths:
-            /some:
-              get:
-                responses:
-                  '200':
-                    description: test
-                    content:
-                      application/json:
-                        schema: null
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { spec: 'error', 'no-enum-type-mismatch': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/paths/~1some/get/responses/200/content/application~1json/schema",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`Schema\` (object) but got \`null\`",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/common/__tests__/no-identical-paths.test.ts

@@ -1,58 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('no-identical-paths', () => {
-  it('should report on identical paths', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          '/good/{id}':
-            get:
-              summary: List all pets
-          '/good/last':
-            get:
-              summary: List all pets
-          '/bad/{id}':
-            get:
-              summary: List all pets
-          '/good/{hash}':
-            get:
-              summary: List all pets
-          '/{id}/valid':
-            get:
-              summary: List all pets
-          '/valid/{id}':
-            get:
-              summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-identical-paths': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1good~1{hash}",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "The path already exists which differs only by path parameter name(s): \`/good/{id}\` and \`/good/{hash}\`.",
-          "ruleId": "no-identical-paths",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

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

@@ -1,53 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('no-invalid-parameter-examples', () => {
-  it('should report on invalid falsy example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        paths:
-          /results:
-            get:
-              parameters:
-                - name: username
-                  in: query
-                  schema:
-                    type: string
-                    maxLength: 15
-                  example: false
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-invalid-parameter-examples': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": {
-            "pointer": "#/paths/~1results/get/parameters/0",
-            "source": "foobar.yaml",
-          },
-          "location": [
-            {
-              "pointer": "#/paths/~1results/get/parameters/0/example",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: type must be string.",
-          "ruleId": "no-invalid-parameter-examples",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

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

@@ -1,86 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('no-invalid-schema-examples', () => {
-  it('should report on invalid falsy example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        components:
-          schemas:
-            Car:
-              type: object
-              properties:
-                color:
-                  type: string
-                  example: 0
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-invalid-schema-examples': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": {
-            "pointer": "#/components/schemas/Car/properties/color",
-            "source": "foobar.yaml",
-          },
-          "location": [
-            {
-              "pointer": "#/components/schemas/Car/properties/color/example",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: type must be string.",
-          "ruleId": "no-invalid-schema-examples",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report on nullable example for OAS3', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.3
-        info: {}
-        paths:
-          /subscriptions:
-            get:
-              responses:
-                "200":
-                  content:
-                    application/json:
-                      schema:
-                        nullable: true
-                        type: object
-                        example: null
-                        allOf:
-                          - $ref: "#/components/schemas/RiskMetadata"
-        components:
-          schemas:
-            RiskMetadata:
-              type: object
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-invalid-schema-examples': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/common/__tests__/no-path-trailing-slash.test.ts

@@ -1,126 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('no-path-trailing-slash', () => {
-  it('should report on trailing slash in path', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          '/bad/':
-            get:
-              summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-path-trailing-slash': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1bad~1",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "\`/bad/\` should not have a trailing slash.",
-          "ruleId": "no-path-trailing-slash",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should report on trailing slash in path on key when referencing', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          '/bad/':
-            $ref: '#/components/pathItems/MyItem'
-        components:
-          pathItems:
-            MyItem:
-              get:
-                summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-path-trailing-slash': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1bad~1",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "\`/bad/\` should not have a trailing slash.",
-          "ruleId": "no-path-trailing-slash",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report on if no trailing slash in path', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          '/good':
-            get:
-              summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-path-trailing-slash': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report on trailing slash in path if the path is root', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          '/':
-            get:
-              summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-path-trailing-slash': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});