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

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

@@ -1,403 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 response-contains-property', () => {
-  it('should report a response object not containing the property', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '201':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456
-		`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { 201: ['id'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1store~1subscribe/post/responses/201/content/application~1json/schema/properties",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '201':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a top-level \\"id\\" property.",
-          "ruleId": "response-contains-property",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should report response objects not containing props 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:
-              '201':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456
-              400:
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        status:
-                          type: integer
-                description: error
-      `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { '2xx': ['id'], '400': ['error'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1store~1subscribe/post/responses/201/content/application~1json/schema/properties",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '201':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456
-              400:
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        status:
-                          type: integer
-                description: error",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a top-level \\"id\\" property.",
-          "ruleId": "response-contains-property",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1store~1subscribe/post/responses/400/content/application~1json/schema/properties",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '201':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456
-              400:
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        status:
-                          type: integer
-                description: error",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a top-level \\"error\\" property.",
-          "ruleId": "response-contains-property",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report response objects containing specified properties', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '201':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456
-                        id: some-id
-              400:
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        status:
-                          type: integer
-                        error:
-                          type: string
-      `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { '2xx': ['id'], '400': ['error'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report a response object when schema type is not object', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '201':
-                content:
-                  text/plain:
-                    schema:
-                      type: string
-      `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { 201: ['id'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report response objects when there is no `names` field specified', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '201':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456
-              400:
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        status:
-                          type: integer
-                description: error
-      `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should not report response objects for 204 status code', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              '204':
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                      properties:
-                        subscriptionId:
-                          type: string
-                          example: AAA-123-BBB-456                  
-      `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { '2xx': ['id'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`Array []`);
-  });
-
-  it('should report response objects when there are no properties', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              200:
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                                      
-      `);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        'response-contains-property': {
-          severity: 'error',
-          names: { '2xx': ['id'] },
-        },
-      }),
-    });
-    expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/paths/~1store~1subscribe/post/responses/200/content/application~1json/schema/properties",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.3
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            responses:
-              200:
-                content:
-                  application/json:
-                    schema:
-                      type: object
-                                      ",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "Response object must contain a top-level \\"id\\" property.",
-          "ruleId": "response-contains-property",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-});

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

@@ -1,41 +0,0 @@
-import { outdent } from 'outdent';
-import { validateDoc } from './utils';
-
-it('should not fail on valid callbacks object', async () => {
-  const source = outdent`
-    openapi: 3.0.2
-    info:
-      title: Test
-      version: '1.0'
-
-    servers:
-      - url: http://google.com
-
-    paths:
-      '/ping':
-        summary: test
-        get:
-          callbacks:
-            test:
-              'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}':
-                post:
-                  requestBody:
-                    description: Callback payload
-                    content:
-                      'application/json':
-                        schema:
-                          $ref: '#/components/schemas/SomePayload'
-                  responses:
-                    '200':
-                      description: webhook successfully processed and no retries will be performed
-          responses:
-            '200':
-              description: example description
-  `;
-
-  expect(
-    await validateDoc(source, {
-      spec: 'error',
-    })
-  ).toMatchInlineSnapshot(`Array []`);
-});

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

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