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

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__/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({ 'operation-4xx-problem-details-rfc7807': 'error' }),
-    });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-
-  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({ 'operation-4xx-problem-details-rfc7807': 'error' }),
-    });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-
-  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({ 'operation-4xx-problem-details-rfc7807': 'error' }),
-    });
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "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": Array [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/oas3/__tests__/response-contains-header.test.ts

@@ -1,389 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 response-contains-header', () => {
-  it('should report a response object not containing the header', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  X-Rate-Limit:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-		`);
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: { '200': ['Content-Length'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1store~1subscribe/post/responses/200/headers",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  X-Rate-Limit:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a \\"Content-Length\\" header.",
-          "ruleId": "response-contains-header",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should report response objects not containing headers for a subset of status codes', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  X-Rate-Limit:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-              400:
-                description: error
-                headers:
-                  AccessForbidden:
-                    description: Access forbidden
-                    content:
-                      application/json:
-                        schema:
-                          type: object
-                          properties:
-                            status:
-                              type: integer
-                              description: The HTTP status code.
-                            error:
-                              type: string
-    `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: {
-            '2XX': ['x-request-id'],
-            '400': ['Content-Length'],
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1store~1subscribe/post/responses/200/headers",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  X-Rate-Limit:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-              400:
-                description: error
-                headers:
-                  AccessForbidden:
-                    description: Access forbidden
-                    content:
-                      application/json:
-                        schema:
-                          type: object
-                          properties:
-                            status:
-                              type: integer
-                              description: The HTTP status code.
-                            error:
-                              type: string",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a \\"x-request-id\\" header.",
-          "ruleId": "response-contains-header",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1store~1subscribe/post/responses/400/headers",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  X-Rate-Limit:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-              400:
-                description: error
-                headers:
-                  AccessForbidden:
-                    description: Access forbidden
-                    content:
-                      application/json:
-                        schema:
-                          type: object
-                          properties:
-                            status:
-                              type: integer
-                              description: The HTTP status code.
-                            error:
-                              type: string",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a \\"Content-Length\\" header.",
-          "ruleId": "response-contains-header",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report response objects containing specified headers', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  X-Rate-Limit:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-                  x-request-id:
-                    description: Request ID
-                    schema:
-                      type: string
-              400:
-                description: error
-                headers:
-                  AccessForbidden:
-                    description: Access forbidden
-                    content:
-                      application/json:
-                        schema:
-                          type: object
-                          properties:
-                            status:
-                              type: integer
-                              description: The HTTP status code.
-                            error:
-                              type: string
-                  Content-Length:
-                    description: The number of bytes in the file
-                    schema:
-                      type: integer
-    `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: {
-            '2xx': ['x-request-id'],
-            '400': ['Content-Length'],
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report response object containing header name upper cased', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  X-Test-Header:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-		`);
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: { '2XX': ['x-test-header'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report response object containing header name in the rule upper cased', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '200':
-                description: successful operation
-                headers:
-                  x-test-header:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-		`);
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: { '2XX': ['X-Test-Header'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should report even if the response is null', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          paths:
-            '/test/':
-              put:
-                responses: 
-                  '200': null
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-header': {
-          severity: 'error',
-          names: { '2XX': ['X-Test-Header'] },
-        },
-      }),
-    });
-
-    expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1test~1/put/responses/200/headers",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "foobar.yaml",
-                "body": "openapi: 3.0.0
-      paths:
-        '/test/':
-          put:
-            responses: 
-              '200': null",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a \\"X-Test-Header\\" header.",
-          "ruleId": "response-contains-header",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-});