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

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

@@ -1,180 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas2 response-contains-header', () => {
-  it('should report a response object not containing the header', async () => {
-    const document = parseYamlToDocument(outdent`
-      swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '201':
-                description: Account Created
-                headers:
-                  Content-Location:
-                    description: Location of created Account
-                    type: string
-              '404':
-                description: User not found
-    `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'response-contains-header': {
-            severity: 'error',
-            names: { '2xx': ['Content-Length'], '4xx': ['Content-Length'] },
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1accounts~1{accountId}/get/responses/201/headers",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '201':
-                description: Account Created
-                headers:
-                  Content-Location:
-                    description: Location of created Account
-                    type: string
-              '404':
-                description: User not found",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a "Content-Length" header.",
-          "ruleId": "response-contains-header",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1accounts~1{accountId}/get/responses/404/headers",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '201':
-                description: Account Created
-                headers:
-                  Content-Location:
-                    description: Location of created Account
-                    type: string
-              '404':
-                description: User not found",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a "Content-Length" header.",
-          "ruleId": "response-contains-header",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report a response object containing the header nor not applicable', async () => {
-    const document = parseYamlToDocument(outdent`
-      swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '201':
-                description: Account Created
-                headers:
-                  Content-Length:
-                    description: calls per hour allowed by the user
-                    schema:
-                      type: integer
-                      format: int32
-              '404':
-                description: User not found
-		`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'response-contains-header': {
-            severity: 'error',
-            names: { '2xx': ['Content-Length'], '400': ['Content-Length'] },
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report a response object when there is no `names` section defined', async () => {
-    const document = parseYamlToDocument(outdent`
-      swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '404':
-                description: User not found
-		`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'response-contains-header': {
-            severity: 'error',
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/oas2/__tests__/response-contains-property.test.ts

@@ -1,161 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas2 response-contains-property', () => {
-  it('should report a response object not containing the property', async () => {
-    const document = parseYamlToDocument(outdent`
-      swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '200':
-                description: Account object returned
-                schema:
-                  type: object
-                  properties:
-                    created_at:
-                      description: Account creation date/time
-                      format: date-time
-                      type: string
-                    owner_email:
-                      description: Account Owner email
-                      type: string
-              '404':
-                description: User not found
-			`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'response-contains-property': {
-            severity: 'error',
-            names: { '2xx': ['id'], '4xx': ['id'] },
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/paths/~1accounts~1{accountId}/get/responses/200/schema/properties",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '200':
-                description: Account object returned
-                schema:
-                  type: object
-                  properties:
-                    created_at:
-                      description: Account creation date/time
-                      format: date-time
-                      type: string
-                    owner_email:
-                      description: Account Owner email
-                      type: string
-              '404':
-                description: User not found",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a top-level "id" property.",
-          "ruleId": "response-contains-property",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report a response object containing the expected property', async () => {
-    const document = parseYamlToDocument(outdent`
-      swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '200':
-                description: Account object returned
-                schema:
-                  type: object
-                  properties:
-                    created_at:
-                      description: Account creation date/time
-                      format: date-time
-                      type: string
-                    id: some-id
-              '404':
-                description: User not found
-                id: some-id
-			`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'response-contains-property': {
-            severity: 'error',
-            names: { '200': ['id'], '4xx': ['id'] },
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report a response object when there is no `names` section defined', async () => {
-    const document = parseYamlToDocument(outdent`
-      swagger: '2.0'
-      schemes:
-        - https
-      basePath: /v2
-      paths:
-        '/accounts/{accountId}':
-          get:
-            description: Retrieve a sub account under the master account.
-            operationId: account
-            responses:
-              '404':
-                description: User not found
-    `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'response-contains-property': {
-            severity: 'error',
-          },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`[]`);
-  });
-});

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

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

package/src/rules/oas2/__tests__/spec/info.test.ts

@@ -1,355 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDoc } from './utils';
-
-describe('OpenAPI Schema 2.0', () => {
-  it('should report if the title of the API is empty ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title:
-        version: '1.0'
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/title",
-          "message": "Expected type \`string\` but got \`null\`.",
-        },
-      ]
-    `);
-  });
-
-  it('should report if in the description field is not string.', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition.
-        version: '1.0'
-        description:
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/description",
-          "message": "Expected type \`string\` but got \`null\`.",
-        },
-      ]
-    `);
-  });
-
-  it('should report if in the termsOfService field is not string', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        termsOfService:
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/termsOfService",
-          "message": "Expected type \`string\` but got \`null\`.",
-        },
-      ]
-    `);
-  });
-
-  it('should not report if the Contact Object is valid', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        termsOfService: http://example.com/terms/
-        contact:
-          name: API Support
-          url: http://www.example.com/support
-          email: support@example.com
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should report if in the Contact Object in URL field is not string', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        termsOfService: http://example.com/terms/
-        contact:
-          url:
-          email: support@example.com
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/contact/url",
-          "message": "Expected type \`string\` but got \`null\`.",
-        },
-      ]
-    `);
-  });
-
-  it('should report if in the Contact Object in email field is not string', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        termsOfService: http://example.com/terms/
-        contact:
-          url: http://example.com/contact/
-          email:
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/contact/email",
-          "message": "Expected type \`string\` but got \`null\`.",
-        },
-      ]
-    `);
-  });
-
-  it('should not report if the License Object is valid', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        license:
-          name: Apache 2.0
-          url: https://www.apache.org/licenses/LICENSE-2.0.html
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should report if the License Object missing field Name', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        license:
-          url: https://www.apache.org/licenses/LICENSE-2.0.html
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/license",
-          "message": "The field \`name\` must be present on this level.",
-        },
-      ]
-    `);
-  });
-
-  it('should report if in the URL field of the License Object is not string', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        license:
-          name: Apache 2.0
-          url:
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/license/url",
-          "message": "Expected type \`string\` but got \`null\`.",
-        },
-      ]
-    `);
-  });
-
-  it('should not report if the URL field of the License Object is not provided', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition. Valid.
-        version: '1.0'
-        license:
-          name: Apache 2.0
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should report if the Version field is not provided', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Example OpenAPI 3 definition.
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info",
-          "message": "The field \`version\` must be present on this level.",
-        },
-      ]
-    `);
-  });
-
-  it('should report if in the Version field is not string', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        version:
-        title: Example OpenAPI 3 definition.
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/info/version",
-          "message": "Expected type \`string\` but got \`null\`.",
-        },
-      ]
-    `);
-  });
-});