@redocly/openapi-core 1.26.0 → 1.27.0

package/lib/rules/spot/no-actions-type-end.d.ts

@@ -1,2 +0,0 @@
-import type { Arazzo1Rule } from '../../visitors';
-export declare const NoActionsTypeEnd: Arazzo1Rule;

package/lib/rules/spot/no-actions-type-end.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoActionsTypeEnd = void 0;
-const NoActionsTypeEnd = () => {
-    return {
-        FailureActionObject: {
-            enter(action, { report, location }) {
-                if (action.type === 'end') {
-                    report({
-                        message: 'The `end` type action is not supported by Spot.',
-                        location: location.child(['type']),
-                    });
-                }
-            },
-        },
-        SuccessActionObject: {
-            enter(action, { report, location }) {
-                if (action.type === 'end') {
-                    report({
-                        message: 'The `end` type action is not supported by Spot.',
-                        location: location.child(['type']),
-                    });
-                }
-            },
-        },
-    };
-};
-exports.NoActionsTypeEnd = NoActionsTypeEnd;

package/lib/rules/spot/parameters-not-in-body.d.ts

@@ -1,2 +0,0 @@
-import type { Arazzo1Rule } from '../../visitors';
-export declare const ParametersNotInBody: Arazzo1Rule;

package/lib/rules/spot/parameters-not-in-body.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParametersNotInBody = void 0;
-const ParametersNotInBody = () => {
-    return {
-        Parameter: {
-            enter(parameter, { report, location }) {
-                if (parameter.in === 'body') {
-                    report({
-                        message: 'The `body` value of the `in` property is not supported by Spot.',
-                        location: location.child(['in']),
-                    });
-                }
-            },
-        },
-    };
-};
-exports.ParametersNotInBody = ParametersNotInBody;

package/lib/rules/spot/version-enum.d.ts

@@ -1,2 +0,0 @@
-import type { Arazzo1Rule } from '../../visitors';
-export declare const VersionEnum: Arazzo1Rule;

package/src/rules/arazzo/__tests__/no-actions-type-end.test.ts

@@ -1,121 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Arazzo no-actions-type-end', () => {
-  const document = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.0'
-      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
-              onSuccess:
-                - name: 'onSuccessActionName'
-                  type: 'end'
-                  stepId: 'buy-ticket'
-              onFailure:
-                - name: 'onFailureActionName'
-                  type: 'end'
-                  stepId: 'buy-ticket'
-              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 type `end` action exists', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'no-actions-type-end': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/steps/0/onSuccess/0/type",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The \`end\` type action is not supported by Spot.",
-          "ruleId": "no-actions-type-end",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/steps/0/onFailure/0/type",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The \`end\` type action is not supported by Spot.",
-          "ruleId": "no-actions-type-end",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report when the type `end` action exists', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {},
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/arazzo/__tests__/parameters-not-in-body.test.ts

@@ -1,73 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
-import { BaseResolver } from '../../../resolve';
-
-describe('Spot parameters-not-in-body', () => {
-  const document = parseYamlToDocument(
-    outdent`
-      arazzo: '1.0.0'
-      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: body
-              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 not report on `body` inside parameter `in` field', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should report on `body` inside parameter `in` field', async () => {
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: { 'parameters-not-in-body': 'error' },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/workflows/0/parameters/0/in",
-              "reportOnKey": false,
-              "source": "arazzo.yaml",
-            },
-          ],
-          "message": "The \`body\` value of the \`in\` property is not supported by Spot.",
-          "ruleId": "parameters-not-in-body",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/spot/no-actions-type-end.ts

@@ -1,27 +0,0 @@
-import type { Arazzo1Rule } from '../../visitors';
-import type { UserContext } from '../../walk';
-
-export const NoActionsTypeEnd: Arazzo1Rule = () => {
-  return {
-    FailureActionObject: {
-      enter(action, { report, location }: UserContext) {
-        if (action.type === 'end') {
-          report({
-            message: 'The `end` type action is not supported by Spot.',
-            location: location.child(['type']),
-          });
-        }
-      },
-    },
-    SuccessActionObject: {
-      enter(action, { report, location }: UserContext) {
-        if (action.type === 'end') {
-          report({
-            message: 'The `end` type action is not supported by Spot.',
-            location: location.child(['type']),
-          });
-        }
-      },
-    },
-  };
-};

package/src/rules/spot/parameters-not-in-body.ts

@@ -1,17 +0,0 @@
-import type { Arazzo1Rule } from '../../visitors';
-import type { UserContext } from '../../walk';
-
-export const ParametersNotInBody: Arazzo1Rule = () => {
-  return {
-    Parameter: {
-      enter(parameter, { report, location }: UserContext) {
-        if (parameter.in === 'body') {
-          report({
-            message: 'The `body` value of the `in` property is not supported by Spot.',
-            location: location.child(['in']),
-          });
-        }
-      },
-    },
-  };
-};