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

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

@@ -1,95 +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({ rules: { 'no-server-example.com': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/servers/0/url",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Server \`url\` should not point to example.com or localhost.",
-          "ruleId": "no-server-example.com",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  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({ rules: { 'no-server-example.com': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('oas3-no-server-example.com: should report on server object with "foo.example.com" url', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          servers:
-            - url: foo.example.com
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'no-server-example.com': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/servers/0/url",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Server \`url\` should not point to example.com or localhost.",
-          "ruleId": "no-server-example.com",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

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({ rules: { 'no-server-trailing-slash': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "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": [],
-        },
-      ]
-    `);
-  });
-
-  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({ rules: { 'no-server-trailing-slash': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  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({ rules: { 'no-server-trailing-slash': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

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({ rules: { 'no-unused-components': 'error' } }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/components/parameters/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: "unused" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/schemas/Unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: "Unused" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/responses/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: "unused" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/examples/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: "unused" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/requestBodies/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: "unused" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/headers/unused",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Component: "unused" is never used.",
-          "ruleId": "no-unused-components",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/oas3/__tests__/operation-4xx-problem-details-rfc7807.test.ts

@@ -1,145 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 operation-4xx-problem-details-rfc7807', () => {
-  it('should report `4xx` must have content type `application/problem+json` ', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              summary: List all pets
-              operationId: listPets
-              responses:
-                '400':
-                  description: Test
-                  content:
-                    application/json:
-                      schema:
-                        type: object
-                        properties:
-                          type:
-                            type: string
-                          title:
-                            type: string
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'operation-4xx-problem-details-rfc7807': 'error' } }),
-    });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1pets/get/responses/400",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Response \`4xx\` must have content-type \`application/problem+json\`.",
-          "ruleId": "operation-4xx-problem-details-rfc7807",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should report `application/problem+json` must have `type` property', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              summary: List all pets
-              operationId: listPets
-              responses:
-                '400':
-                  description: Test
-                  content:
-                    application/problem+json:
-                      schema:
-                        type: object
-                        properties:
-                          title:
-                            type: string
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'operation-4xx-problem-details-rfc7807': 'error' } }),
-    });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1pets/get/responses/400/content/application~1problem+json/schema/properties/type",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "SchemaProperties object should contain \`type\` field.",
-          "ruleId": "operation-4xx-problem-details-rfc7807",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should report `application/problem+json` must have `schema` property', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              summary: List all pets
-              operationId: listPets
-              responses:
-                '400':
-                  description: Test
-                  content:
-                    application/problem+json:
-                      example: asd
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: { 'operation-4xx-problem-details-rfc7807': 'error' } }),
-    });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1pets/get/responses/400/content/application~1problem+json/schema",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "MediaType object should contain \`schema\` field.",
-          "ruleId": "operation-4xx-problem-details-rfc7807",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});