@redocly/openapi-core 1.0.0 → 1.0.2

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

@@ -0,0 +1,155 @@
+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({
+        'response-contains-property': {
+          severity: 'error',
+          names: { '2xx': ['id'], '4xx': ['id'] },
+        },
+      }),
+    });
+    expect(results).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "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": Array [],
+        },
+      ]
+    `);
+  });
+
+  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({
+        'response-contains-property': {
+          severity: 'error',
+          names: { '200': ['id'], '4xx': ['id'] },
+        },
+      }),
+    });
+    expect(results).toMatchInlineSnapshot(`Array []`);
+  });
+
+  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({
+        'response-contains-property': {
+          severity: 'error',
+        },
+      }),
+    });
+    expect(results).toMatchInlineSnapshot(`Array []`);
+  });
+});

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

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

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

@@ -0,0 +1,355 @@
+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(`
+      Array [
+        Object {
+          "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(`
+      Array [
+        Object {
+          "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(`
+      Array [
+        Object {
+          "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(`Array []`);
+  });
+
+  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(`
+      Array [
+        Object {
+          "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(`
+      Array [
+        Object {
+          "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(`Array []`);
+  });
+
+  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(`
+      Array [
+        Object {
+          "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(`
+      Array [
+        Object {
+          "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(`Array []`);
+  });
+
+  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(`
+      Array [
+        Object {
+          "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(`
+      Array [
+        Object {
+          "location": "#/info/version",
+          "message": "Expected type \`string\` but got \`null\`.",
+        },
+      ]
+    `);
+  });
+});

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

@@ -0,0 +1,123 @@
+import { outdent } from 'outdent';
+import { lintDoc } from './utils';
+
+describe('OpenAPI Schema 2.0', () => {
+  it('should not report of a valid GET operation object', async () => {
+    const source = outdent`
+      swagger: '2.0'
+      info:
+        title: Test
+        version: '1.0'
+
+      paths:
+        '/ping':
+          get:
+            responses:
+              '200':
+                description: example description
+    `;
+
+    expect(
+      await lintDoc(source, {
+        spec: 'error',
+      })
+    ).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('should not report of a valid PUT operation object', async () => {
+    const source = outdent`
+      swagger: '2.0'
+      info:
+        title: Test
+        version: '1.0'
+
+      paths:
+        '/ping':
+          put:
+            tags:
+              - pet
+            summary: Update an existing pet
+            description: ''
+            operationId: updatePet
+            responses:
+              '400':
+                description: Invalid ID supplied
+    `;
+
+    expect(
+      await lintDoc(source, {
+        spec: 'error',
+      })
+    ).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('should not report of a valid Post operation object', async () => {
+    const source = outdent`
+      swagger: '2.0'
+      info:
+        title: Test
+        version: '1.0'
+
+      paths:
+        '/ping':
+          post:
+            tags:
+              - pet
+            summary: uploads an image
+            description: ''
+            operationId: uploadFile
+            parameters:
+              - name: petId
+                in: path
+                description: ID of pet to update
+                required: true
+                type: integer
+                format: int64
+            responses:
+              '200':
+                description: successful operation
+    `;
+
+    expect(
+      await lintDoc(source, {
+        spec: 'error',
+      })
+    ).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('should not report of a valid delete operation object', async () => {
+    const source = outdent`
+      swagger: '2.0'
+      info:
+        title: Test
+        version: '1.0'
+
+      paths:
+        '/ping':
+          delete:
+            tags:
+              - store
+            summary: Delete purchase order by ID
+            description: >-
+              For valid response try integer IDs with value < 1000. Anything above
+              1000 or nonintegers will generate API errors
+            operationId: deleteOrder
+            parameters:
+              - name: orderId
+                in: path
+                description: ID of the order that needs to be deleted
+                required: true
+                type: string
+                minimum: 1
+            responses:
+              '400':
+                description: Invalid ID supplied
+    `;
+
+    expect(
+      await lintDoc(source, {
+        spec: 'error',
+      })
+    ).toMatchInlineSnapshot(`Array []`);
+  });
+});