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

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

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

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

@@ -1,253 +0,0 @@
-import { outdent } from 'outdent';
-import { validateDoc } from './utils';
-
-it('should not report if summary field is valid', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        summary: test
-        get:
-          responses:
-            '200':
-              description: example description
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`Array []`);
-});
-
-it('should report if summary field is not string ', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        summary:
-        get:
-          responses:
-            '200':
-              description: example description
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`
-    Array [
-      Object {
-        "location": "#/paths/~1ping/summary",
-        "message": "Expected type \`string\` but got \`null\`.",
-      },
-    ]
-  `);
-});
-
-it('should not report if description field is valid', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        description: test
-        get:
-          responses:
-            '200':
-              description: example description
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`Array []`);
-});
-
-it('should report if description field is not string', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        description:
-        get:
-          responses:
-            '200':
-              description: example description
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`
-    Array [
-      Object {
-        "location": "#/paths/~1ping/description",
-        "message": "Expected type \`string\` but got \`null\`.",
-      },
-    ]
-  `);
-});
-
-it('should not report of a valid GET operation object', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        get:
-          responses:
-            '200':
-              description: example description
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`Array []`);
-});
-
-it('should not report of a valid PUT operation object', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        put:
-          tags:
-            - pet
-          summary: Update an existing pet
-          description: ''
-          operationId: updatePet
-          responses:
-            '400':
-              description: Invalid ID supplied
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`Array []`);
-});
-
-it('should not report of a valid Post operation object', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    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
-              schema:
-                type: integer
-                format: int64
-          responses:
-            '200':
-              description: successful operation
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`Array []`);
-});
-
-it('should not report of a valid delete operation object', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    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
-              schema:
-                type: string
-                minimum: 1
-          responses:
-            '400':
-              description: Invalid ID supplied
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    }),
-  ).toMatchInlineSnapshot(`Array []`);
-});