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

package/src/rules/common/__tests__/path-not-include-query.test.ts

@@ -1,64 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 path-not-include-query', () => {
-  it('should report on path object if query params in pathitem', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /some?input:
-              get:
-                summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'path-not-include-query': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1some?input",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Don't put query string items in the path, they belong in parameters with \`in: query\`.",
-          "ruleId": "path-not-include-query",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report on path object if no query params in pathitem', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-      openapi: 3.0.0
-      paths:
-        /some:
-          get:
-            summary: List all pets
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'path-not-include-query': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});

package/src/rules/common/__tests__/path-params-defined.test.ts

@@ -1,202 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 path-params-defined', () => {
-  it('should not report on defined params', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /pets/{a}/{b}:
-              parameters:
-                - name: a
-                  in: path
-              get:
-                parameters:
-                 - name: b
-                   in: path
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'path-params-defined': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should report on undefined param params', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /pets/{a}/{b}:
-              parameters:
-                - name: a
-                  in: path
-                - name: b
-                  in: header
-              get:
-                parameters:
-                 - name: b
-                   in: query
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'path-params-defined': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pets~1{a}~1{b}/get/parameters",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "The operation does not define the path parameter \`{b}\` expected by path \`/pets/{a}/{b}\`.",
-          "ruleId": "path-params-defined",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should report on undeclared param', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /pets/{a}:
-              parameters:
-                - name: a
-                  in: path
-                - name: d
-                  in: path
-              get:
-                parameters:
-                 - name: c
-                   in: path
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'path-params-defined': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pets~1{a}/parameters/1/name",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Path parameter \`d\` is not used in the path \`/pets/{a}\`.",
-          "ruleId": "path-params-defined",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pets~1{a}/get/parameters/0/name",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Path parameter \`c\` is not used in the path \`/pets/{a}\`.",
-          "ruleId": "path-params-defined",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should fail cause POST has no parameters', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /pets/{a}:
-              get:
-                parameters:
-                 - name: a
-                   in: path
-              post:
-                description: without parameters
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'path-params-defined': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pets~1{a}/post/parameters",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "The operation does not define the path parameter \`{a}\` expected by path \`/pets/{a}\`.",
-          "ruleId": "path-params-defined",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should apply parameters for POST operation from path parameters', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /pets/{a}:
-              parameters:
-                - name: a
-                  in: path
-              get:
-                parameters:
-                 - name: a
-                   in: path
-              post:
-                description: without parameters
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'path-params-defined': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});

package/src/rules/common/__tests__/paths-kebab-case.test.ts

@@ -1,108 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 paths-kebab-case', () => {
-  it('should report on no kebab-case path', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /someTest:
-              get:
-                summary: List all pets
-            /test-123:
-              get:
-                summary: Test
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'paths-kebab-case': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1someTest",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "\`/someTest\` does not use kebab-case.",
-          "ruleId": "paths-kebab-case",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-  it('should report when snake_case is used', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            /some_test:
-              get:
-                summary: List all pets
-            /test-123:
-              get:
-                summary: Test
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'paths-kebab-case': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1some_test",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "\`/some_test\` does not use kebab-case.",
-          "ruleId": "paths-kebab-case",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should allow trailing slash in path with "paths-kebab-case" rule', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-            openapi: 3.0.0
-            paths:
-              /some/:
-                get:
-                  summary: List all pets
-          `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'paths-kebab-case': 'error',
-        'no-path-trailing-slash': 'off',
-      }),
-    });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});

package/src/rules/common/__tests__/scalar-property-missing-example.test.ts

@@ -1,264 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 scalar-property-missing-example', () => {
-  it('should report on a scalar property missing example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                email:
-                  description: User email address
-                  type: string
-                  format: email
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/schemas/User/properties/email",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Scalar property should have \\"example\\" defined.",
-          "ruleId": "scalar-property-missing-example",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-});
-
-describe('Oas3.1 scalar-property-missing-example', () => {
-  it('should report on a scalar property missing example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                email:
-                  description: User email address
-                  type: string
-                  format: email
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/schemas/User/properties/email",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Scalar property should have \\"example\\" or \\"examples\\" defined.",
-          "ruleId": "scalar-property-missing-example",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report on a scalar property with an example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                email:
-                  description: User email address
-                  type: string
-                  format: email
-                  example: john.smith@example.com
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report on a scalar property with an examples', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                email:
-                  description: User email address
-                  type: string
-                  format: email
-                  examples: 
-                  - john.smith@example.com
-                  - other@example.com
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report on a non-scalar property missing an example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        components:
-          schemas:
-            Pet:
-              type: object
-              required:
-                - photoUrls
-              properties:
-                photoUrls:
-                  description: The list of URL to a cute photos featuring pet
-                  type: array
-                  maxItems: 20
-                  xml:
-                    name: photoUrl
-                    wrapped: true
-                  items:
-                    type: string
-                    format: url
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report on a scalar property of binary format missing an example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                responses:
-                  type: string
-                  format: binary
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report on a scalar property of falsy values', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                testBool:
-                  type: boolean
-                  example: false
-                testString:
-                  type: string
-                  example: ""
-                testNumber:
-                  type: number
-                  example: 0
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report on a nullable scalar property values', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                testBool:
-                  type: string
-                  nullable: true
-                  example: null
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});