@redocly/openapi-core 1.0.0-beta.126 → 1.0.0-beta.127

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({ 'no-ambiguous-paths': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-});

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({ 'no-enum-type-mismatch': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  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({ 'no-enum-type-mismatch': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  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({ 'no-enum-type-mismatch': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-
-  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({ 'no-enum-type-mismatch': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-
-  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({ spec: 'error', 'no-enum-type-mismatch': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "from": undefined,
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1some/get/responses/200/content/application~1json/schema",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`Schema\` (object) but got \`null\`",
-          "ruleId": "spec",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-});

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({ 'no-identical-paths': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-});

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

@@ -1,85 +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({ 'no-path-trailing-slash': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-
-  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({ 'no-path-trailing-slash': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  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({ 'no-path-trailing-slash': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});

package/src/rules/common/__tests__/operation-2xx-response.test.ts

@@ -1,192 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 operation-2xx-response', () => {
-  it('should report missing 2xx response', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            '/test':
-              put:
-                responses:
-                  400:
-                    description: bad response
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'operation-2xx-response': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1test/put/responses",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Operation must have at least one \`2XX\` response.",
-          "ruleId": "operation-2xx-response",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report for present 2xx response', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            '/test/':
-              put:
-                responses:
-                  200:
-                    description: ok
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'operation-2xx-response': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report for present default', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            '/test/':
-              put:
-                responses:
-                  default:
-                    description: ok
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'operation-2xx-response': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should report even if the responses are null', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            '/test/':
-              put:
-                responses: null
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'operation-2xx-response': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1test~1/put/responses",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Operation must have at least one \`2XX\` response.",
-          "ruleId": "operation-2xx-response",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should report missing 2xx response in webhooks when enabled', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.1.0
-          webhooks:
-            '/test/':
-              put:
-                responses:
-                  400:
-                    description: success response
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'operation-2xx-response': { severity: 'error', validateWebhooks: true },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/webhooks/~1test~1/put/responses",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Operation must have at least one \`2XX\` response.",
-          "ruleId": "operation-2xx-response",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report missing 2xx response in webhooks when not enabled', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          x-webhooks:
-            '/test/':
-              put:
-                responses:
-                  400:
-                    description: success response
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'operation-2xx-response': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});