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

package/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts

@@ -1,126 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Arazzo no-criteria-xpath', () => {
-  const document = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.1'
-      info:
-        title: Cool API
-        version: 1.0.0
-        description: A cool API
-      sourceDescriptions:
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-      workflows:
-        - workflowId: get-museum-hours
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: create-event
-              description: >-
-                Create a new special event.
-              operationPath: $sourceDescriptions.museum-api#/paths/~1special-events/post
-              requestBody:
-                payload:
-                  name: 'Mermaid Treasure Identification and Analysis'
-                  location: 'Under the seaaa 🦀 🎶 🌊.'
-                  eventDescription: 'Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.'
-                  dates:
-                    - '2023-09-05'
-                    - '2023-09-08'
-                  price: 0
-              successCriteria:
-                - condition: $statusCode == 201
-                - context: $response.body
-                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
-                  type:
-                    type: jsonpath
-                    version: draft-goessner-dispatch-jsonpath-00
-                - context: $response.body
-                  condition: $.name == 'Orca Identification and Analysis'
-                  type: xpath
-                - context: $response.body
-                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
-                  type:
-                    type: xpath
-                    version: xpath-30
-              outputs:
-                createdEventId: $response.body.eventId
-                name: $response.body.name
-        - workflowId: get-museum-hours-2
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: get-museum-hours
-              description: >-
-                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
-              operationId: museum-api.getMuseumHours
-              successCriteria:
-                - condition: $statusCode == 200
-    `,
-    'arazzo.yaml'
-  );
-
-  it('should report when the `xpath` criteria exists', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'no-criteria-xpath': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/steps/0/successCriteria/2/type",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The \`xpath\` type criteria is not supported by Respect.",
-          "ruleId": "no-criteria-xpath",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/steps/0/successCriteria/3/type",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The \`xpath\` type criteria is not supported by Respect.",
-          "ruleId": "no-criteria-xpath",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report when the `xpath` criteria exists', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {},
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/arazzo/__tests__/parameters-unique.test.ts

@@ -1,113 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Arazzo parameters-unique', () => {
-  const document = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.1'
-      info:
-        title: Cool API
-        version: 1.0.0
-        description: A cool API
-      sourceDescriptions:
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-      workflows:
-        - workflowId: get-museum-hours
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: get-museum-hours
-              description: >-
-                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
-              operationId: museum-api.getMuseumHours
-              parameters:
-                - in: header
-                  name: Secret
-                  value: Basic Og==
-                - in: header
-                  name: Secret
-                  value: Basic Og==
-                - reference: $components.parameters.notify
-                  value: 12
-                - reference: $components.parameters.notify
-                  value: 12
-              successCriteria:
-                - condition: $statusCode == 200
-    `,
-    'arazzo.yaml'
-  );
-
-  it('should not report on `parameters` duplication', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should report on `parameters` duplication', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'parameters-unique': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/parameters/1",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The parameter \`name\` must be unique amongst listed parameters.",
-          "ruleId": "parameters-unique",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/steps/0/parameters/1",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The parameter \`name\` must be unique amongst listed parameters.",
-          "ruleId": "parameters-unique",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/steps/0/parameters/3",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The parameter \`reference\` must be unique amongst listed parameters.",
-          "ruleId": "parameters-unique",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts

@@ -1,108 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Arazzo requestBody-replacements-unique', () => {
-  const document = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.1'
-      info:
-        title: Cool API
-        version: 1.0.0
-        description: A cool API
-      sourceDescriptions:
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-      workflows:
-        - workflowId: get-museum-hours
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: create-event
-              description: >-
-                Create a new special event.
-              operationPath: $sourceDescriptions.museum-api#/paths/~1special-events/post
-              requestBody:
-                replacements:
-                  - target: $randomString
-                    value: $randomString
-                  - target: $randomString
-                    value: $randomString
-                payload:
-                  name: 'Mermaid Treasure Identification and Analysis'
-                  location: 'Under the seaaa 🦀 🎶 🌊.'
-                  eventDescription: 'Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.'
-                  dates:
-                    - '2023-09-05'
-                    - '2023-09-08'
-                  price: 0
-              successCriteria:
-                - condition: $statusCode == 201
-                - context: $response.body
-                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
-                  type: jsonpath
-              outputs:
-                createdEventId: $response.body.eventId
-                name: $response.body.name
-        - workflowId: get-museum-hours-2
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: get-museum-hours
-              description: >-
-                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
-              operationId: museum-api.getMuseumHours
-              successCriteria:
-                - condition: $statusCode == 200
-    `,
-    'arazzo.yaml'
-  );
-
-  it('should report when the `replacement` is not unique amongst all `replacements` in the RequestBody', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'requestBody-replacements-unique': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/steps/0/requestBody/replacements/1/target",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "Every \`replacement\` in \`requestBody\` must be unique.",
-          "ruleId": "requestBody-replacements-unique",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report when the `replacement` is not unique amongst all `replacements` in the RequestBody', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {},
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/arazzo/__tests__/respect-supported-versions.test.ts

@@ -1,116 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Arazzo respect-supported-versions', () => {
-  const documentWithUnsupportedVersion = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.2'
-      info:
-        title: Cool API
-        version: 1.0.0
-        description: A cool API
-      sourceDescriptions:
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-      workflows:
-        - workflowId: get-museum-hours
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: get-museum-hours
-              description: >-
-                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
-              operationId: museum-api.getMuseumHours
-              successCriteria:
-                - condition: $statusCode == 200
-    `,
-    'arazzo.yaml'
-  );
-
-  const documentWithSupportedVersion = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.1'
-      info:
-        title: Cool API
-        version: 1.0.0
-        description: A cool API
-      sourceDescriptions:
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-      workflows:
-        - workflowId: get-museum-hours
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: get-museum-hours
-              description: >-
-                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
-              operationId: museum-api.getMuseumHours
-              successCriteria:
-                - condition: $statusCode == 200
-    `,
-    'arazzo.yaml'
-  );
-
-  it('should report on arazzo version error', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document: documentWithUnsupportedVersion,
-      config: await makeConfig({
-        rules: { 'respect-supported-versions': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/arazzo",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "Only 1.0.1 Arazzo version is fully supported by Respect.",
-          "ruleId": "respect-supported-versions",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report on arazzo version error when supported version is used', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document: documentWithSupportedVersion,
-      config: await makeConfig({
-        rules: { 'respect-supported-versions': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report on arazzo version error when rule is not configured', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document: documentWithSupportedVersion,
-      config: await makeConfig({
-        rules: {},
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/arazzo/__tests__/source-description-type.test.ts

@@ -1,78 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Arazzo sourceDescription-type', () => {
-  const document = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.1'
-      info:
-        title: Cool API
-        version: 1.0.0
-        description: A cool API
-      sourceDescriptions:
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-        - name: api
-          type: none
-          x-serverUrl: 'http://localhost/api'
-      workflows:
-        - workflowId: get-museum-hours
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: get-museum-hours
-              description: >-
-                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
-              operationId: museum-api.getMuseumHours
-              successCriteria:
-                - condition: $statusCode == 200
-    `,
-    'arazzo.yaml'
-  );
-
-  it('should report on sourceDescription with type `none`', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'sourceDescription-type': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/sourceDescriptions/1",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The \`type\` property of the \`sourceDescription\` object must be either \`openapi\` or \`arazzo\`.",
-          "ruleId": "sourceDescription-type",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report on sourceDescription with type `none`', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'sourceDescription-type': 'off' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/arazzo/__tests__/sourceDescription-name-unique.test.ts

@@ -1,78 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Arazzo sourceDescription-name-unique', () => {
-  const document = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.1'
-      info:
-        title: Cool API
-        version: 1.0.0
-        description: A cool API
-      sourceDescriptions:
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-        - name: museum-api
-          type: openapi
-          url: openapi.yaml
-      workflows:
-        - workflowId: get-museum-hours
-          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
-          parameters:
-            - in: header
-              name: Authorization
-              value: Basic Og==
-          steps:
-            - stepId: get-museum-hours
-              description: >-
-                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
-              operationId: museum-api.getMuseumHours
-              successCriteria:
-                - condition: $statusCode == 200
-    `,
-    'arazzo.yaml'
-  );
-
-  it('should report an error when sourceDescription `name` is not unique among all sourceDescriptions', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'sourceDescription-name-unique': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/sourceDescriptions/1",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The \`name\` must be unique amongst all SourceDescriptions.",
-          "ruleId": "sourceDescription-name-unique",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report an error when sourceDescription `name` is not unique among all sourceDescriptions', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {},
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});