@redocly/openapi-core 1.0.0-beta.98 → 1.0.0-rc.1

package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts

@@ -1,392 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('no-invalid-media-type-examples', () => {
-  it('should report on invalid example', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      example:
-                        a: 13
-                        b: "string"
-                      schema:
-                        type: object
-                        properties:
-                          a:
-                            type: string
-                          b:
-                            type: number
-
-      `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "from": Object {
-            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
-            "source": "foobar.yaml",
-          },
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/example/a",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: \`a\` property type must be string.",
-          "ruleId": "no-invalid-media-type-examples",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "from": Object {
-            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
-            "source": "foobar.yaml",
-          },
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/example/b",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: \`b\` property type must be number.",
-          "ruleId": "no-invalid-media-type-examples",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should report on invalid example with disallowAdditionalProperties', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      example:
-                        a: "string"
-                        b: 13
-                        c: unknown
-                      schema:
-                        type: object
-                        properties:
-                          a:
-                            type: string
-                          b:
-                            type: number
-
-      `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'no-invalid-media-type-examples': {
-          severity: 'error',
-          disallowAdditionalProperties: true,
-        },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "from": Object {
-            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
-            "source": "foobar.yaml",
-          },
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/example/c",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: must NOT have additional properties \`c\`.",
-          "ruleId": "no-invalid-media-type-examples",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not on invalid example with disallowAdditionalProperties', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      example:
-                        a: "string"
-                        b: 13
-                      schema:
-                        type: object
-                        properties:
-                          a:
-                            type: string
-                          b:
-                            type: number
-
-      `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'no-invalid-media-type-examples': {
-          severity: 'error',
-          disallowAdditionalProperties: true,
-        },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not on invalid examples', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        components:
-          examples:
-            test:
-              value:
-                a: 23
-                b: 25
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      examples:
-                        test:
-                          $ref: '#/components/examples/test'
-                        test2:
-                          value:
-                            a: test
-                            b: 35
-                      schema:
-                        type: object
-                        properties:
-                          a:
-                            type: string
-                          b:
-                            type: number
-
-      `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'no-invalid-media-type-examples': {
-          severity: 'error',
-          disallowAdditionalProperties: true,
-        },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "from": Object {
-            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
-            "source": "foobar.yaml",
-          },
-          "location": Array [
-            Object {
-              "pointer": "#/components/examples/test/value/a",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: \`a\` property type must be string.",
-          "ruleId": "no-invalid-media-type-examples",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report if no examples', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      example:
-                        a: test
-                        b: 35
-
-      `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report if no schema', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      schema:
-                        type: object
-                        properties:
-                          a:
-                            type: string
-                          b:
-                            type: number
-
-      `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should work with cross-file $ref', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        components:
-          schemas:
-            C:
-              $ref: './fixtures/common.yaml#/components/schemas/A'
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      example: {
-                        "a": "test",
-                        "b": "test"
-                      }
-                      schema:
-                        $ref: '#/components/schemas/C'
-
-      `,
-      __dirname + '/foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not throw for ajv throw', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      example: {}
-                      schema:
-                        nullable: true
-
-      `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "from": Object {
-            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
-            "source": "foobar.yaml",
-          },
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/schema",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example validation errored: \\"nullable\\" cannot be used without \\"type\\".",
-          "ruleId": "no-invalid-media-type-examples",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/oas3/__tests__/no-server-example.com.test.ts

@@ -1,60 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 oas3-no-server-example.com', () => {
-  it('oas3-no-server-example.com: should report on server object with "example.com" url', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          servers:
-            - url: example.com
-        `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-server-example.com': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/servers/0/url",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Server \`url\` should not point at example.com.",
-          "ruleId": "no-server-example.com",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('oas3-no-server-example.com: should not report on server object with not "example.com" url', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          servers:
-            - url: not-example.com
-        `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-server-example.com': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});

package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts

@@ -1,79 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 oas3-no-server-trailing-slash', () => {
-  it('oas3-no-server-trailing-slash: should report on server object with trailing slash', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          servers:
-            - url: https://somedomain.com/
-        `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-server-trailing-slash': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/servers/0/url",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Server \`url\` should not have a trailing slash.",
-          "ruleId": "no-server-trailing-slash",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('oas3-no-server-trailing-slash: should not report on server object with no trailing slash', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          servers:
-            - url: https://somedomain.com
-        `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-server-trailing-slash': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('oas3-no-server-trailing-slash: should not report on server object with no trailing slash if the url is root', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          servers:
-            - url: /
-        `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-server-trailing-slash': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});

package/src/rules/oas3/__tests__/no-unused-components.test.ts

@@ -1,131 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 no-unused-components', () => {
-  it('should report unused components', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              summary: List all pets
-              operationId: listPets
-              parameters:
-                - $ref: '#/components/parameters/used'
-        components:
-          parameters:
-            used:
-              name: used
-            unused:
-              name: unused
-          responses:
-            unused: {}
-          examples:
-            unused: {}
-          requestBodies:
-            unused: {}
-          headers:
-            unused: {}
-          schemas:
-            Unused:
-              type: integer
-              enum:
-                - 1
-                - 2
-        `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ 'no-unused-components': 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/parameters/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: \\"unused\\" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/schemas/Unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: \\"Unused\\" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/responses/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: \\"unused\\" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/examples/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: \\"unused\\" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/requestBodies/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: \\"unused\\" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/components/headers/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: \\"unused\\" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/oas3/__tests__/spec/callbacks.test.ts

@@ -1,41 +0,0 @@
-import { outdent } from 'outdent';
-import { validateDoc } from './utils';
-
-it('should not fail on valid callbacks object', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        summary: test
-        get:
-          callbacks:
-            test:
-              'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}':
-                post:
-                  requestBody:
-                    description: Callback payload
-                    content:
-                      'application/json':
-                        schema:
-                          $ref: '#/components/schemas/SomePayload'
-                  responses:
-                    '200':
-                      description: webhook successfully processed and no retries will be performed
-          responses:
-            '200':
-              description: example description
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`Array []`);
-});

package/src/rules/oas3/__tests__/spec/fixtures/description.md

@@ -1 +0,0 @@
-Hello