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

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(`
-      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

@@ -1,123 +0,0 @@
-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 []`);
-  });
-});

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

@@ -1,245 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDoc } from './utils';
-
-describe('OpenAPI Schema', () => {
-  it('should not report if Path object is valid ', 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 if Path object is empty ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths: {}
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      }),
-    ).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should report if Path object is not present ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      }),
-    ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": "#/",
-          "message": "The field \`paths\` must be present on this level.",
-        },
-      ]
-    `);
-  });
-
-  it('should not report if Path object is empty ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths: {}
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      }),
-    ).toMatchInlineSnapshot(`Array []`);
-  });
-
-  //Check: no error
-  it('should report if the field name is not begin with a forward slash (/) ', 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 [
-        Object {
-          "location": "#/paths/ping",
-          "message": "Property \`ping\` is not expected here.",
-        },
-      ]
-    `);
-  });
-
-  it('should report if paths are considered identical and invalid', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        /pets/{petId}:
-          get:
-            responses:
-              '200':
-                description: example description
-        /pets/{name}:
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        'paths-identical': 'error',
-      }),
-    ).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report valid matching URLs', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/pets/{petId}':
-          get:
-            responses:
-              '200':
-                description: example description
-        '/pets/mine':
-           get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      }),
-    ).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report in case of ambiguous matching ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/{entity}/me':
-          get:
-            responses:
-              '200':
-                description: example description
-        '/books/{id}':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      }),
-    ).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report if Path Item is empty ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/ping': {}
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      }),
-    ).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report of a valid Parameter Object', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        /pet:
-          parameters:
-            - name: Accept-Language
-              in: header
-              description: "test"
-              required: false
-              type: string
-              default: en-AU
-          post:
-            tags:
-              - pet
-            summary: Add a new pet to the store
-            description: Add new pet to the store inventory.
-            operationId: addPet
-            responses:
-              '405':
-                description: Invalid input
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      }),
-    ).toMatchInlineSnapshot(`Array []`);
-  });
-});