@redocly/openapi-core 1.26.0 → 1.27.0

package/src/config/minimal.ts

@@ -187,8 +187,6 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
   arazzo1Rules: {
     'criteria-unique': 'off',
     'no-criteria-xpath': 'off',
-    'no-actions-type-end': 'off',
-    'parameters-not-in-body': 'off',
     'parameters-unique': 'off',
     'requestBody-replacements-unique': 'off',
     'sourceDescription-type': 'off',
@@ -197,7 +195,7 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'step-onFailure-unique': 'off',
     'stepId-unique': 'error',
     'sourceDescription-name-unique': 'off',
-    'version-enum': 'off',
+    'spot-supported-versions': 'off',
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'off',
   },

package/src/config/recommended-strict.ts

@@ -186,9 +186,7 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
   },
   arazzo1Rules: {
     'criteria-unique': 'error',
-    'no-criteria-xpath': 'error',
-    'no-actions-type-end': 'error',
-    'parameters-not-in-body': 'error',
+    'no-criteria-xpath': 'off',
     'parameters-unique': 'error',
     'requestBody-replacements-unique': 'error',
     'sourceDescription-type': 'error',
@@ -197,7 +195,7 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'stepId-unique': 'error',
     'sourceDescription-name-unique': 'error',
     'sourceDescriptions-not-empty': 'error',
-    'version-enum': 'error',
+    'spot-supported-versions': 'off',
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'error',
   },

package/src/config/recommended.ts

@@ -186,9 +186,7 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
   },
   arazzo1Rules: {
     'criteria-unique': 'warn',
-    'no-criteria-xpath': 'warn',
-    'no-actions-type-end': 'warn',
-    'parameters-not-in-body': 'warn',
+    'no-criteria-xpath': 'off',
     'parameters-unique': 'error',
     'requestBody-replacements-unique': 'warn',
     'sourceDescription-type': 'error',
@@ -197,7 +195,7 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'stepId-unique': 'error',
     'sourceDescription-name-unique': 'error',
     'sourceDescriptions-not-empty': 'error',
-    'version-enum': 'warn',
+    'spot-supported-versions': 'off',
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'error',
   },

package/src/config/rules.ts

@@ -39,19 +39,21 @@ export function initRules(
           return undefined;
         }
         const severity: ProblemSeverity = ruleSettings.severity;
-
+        const message = ruleSettings.message;
         const visitors = rule(ruleSettings);
 
         if (Array.isArray(visitors)) {
           return visitors.map((visitor: any) => ({
             severity,
             ruleId,
+            message,
             visitor: visitor,
           }));
         }
 
         return {
           severity,
+          message,
           ruleId,
           visitor: visitors, // note: actually it is only one visitor object
         };

package/src/config/spec.ts

@@ -11,9 +11,8 @@ const spec: PluginStyleguideConfig<'built-in'> = {
   async2Rules: {},
   async3Rules: {},
   arazzo1Rules: {
-    'parameters-not-in-body': 'error',
     'sourceDescription-type': 'error',
-    'version-enum': 'error',
+    'spot-supported-versions': 'off',
     'workflowId-unique': 'error',
     'stepId-unique': 'error',
     'sourceDescription-name-unique': 'error',
@@ -23,8 +22,7 @@ const spec: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'error',
     'step-onFailure-unique': 'error',
     'requestBody-replacements-unique': 'error',
-    'no-criteria-xpath': 'error',
-    'no-actions-type-end': 'error',
+    'no-criteria-xpath': 'off',
     'criteria-unique': 'error',
   },
 };

package/src/config/types.ts

@@ -26,15 +26,11 @@ import type { JSONSchema } from 'json-schema-to-ts';
 
 export type RuleSeverity = ProblemSeverity | 'off';
 
-export type RuleSettings = { severity: RuleSeverity };
+export type RuleSettings = { severity: RuleSeverity; message?: string };
 
 export type PreprocessorSeverity = RuleSeverity | 'on';
 
-export type RuleConfig =
-  | RuleSeverity
-  | ({
-      severity?: ProblemSeverity;
-    } & Record<string, any>);
+export type RuleConfig = RuleSeverity | (Partial<RuleSettings> & Record<string, any>);
 
 export type PreprocessorConfig =
   | PreprocessorSeverity

package/src/rules/arazzo/__tests__/{version-enum.test.ts → spot-supported-versions.test.ts}

@@ -3,7 +3,7 @@ import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
-describe('Arazzo version-enum', () => {
+describe('Arazzo spot-supported-versions', () => {
   const document = parseYamlToDocument(
     outdent`
       arazzo: '1.0.1'
@@ -38,7 +38,7 @@ describe('Arazzo version-enum', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        rules: { 'version-enum': 'error' },
+        rules: { 'spot-supported-versions': 'error' },
       }),
     });
 
@@ -53,7 +53,7 @@ describe('Arazzo version-enum', () => {
             },
           ],
           "message": "Only 1.0.0 Arazzo version is supported by Spot.",
-          "ruleId": "version-enum",
+          "ruleId": "spot-supported-versions",
           "severity": "error",
           "suggest": [],
         },

package/src/rules/arazzo/index.ts

@@ -1,9 +1,8 @@
 import { Struct } from '../common/struct';
 import { Assertions } from '../common/assertions';
-import { ParametersNotInBody } from '../spot/parameters-not-in-body';
 import { SourceDescriptionType } from '../arazzo/sourceDescription-type';
 import { SourceDescriptionsNotEmpty } from './sourceDescriptions-not-empty';
-import { VersionEnum } from '../spot/version-enum';
+import { SpotSupportedVersions } from '../spot/spot-supported-versions';
 import { WorkflowIdUnique } from './workflowId-unique';
 import { StepIdUnique } from './stepId-unique';
 import { SourceDescriptionsNameUnique } from './sourceDescriptions-name-unique';
@@ -13,7 +12,6 @@ import { StepOnSuccessUnique } from './step-onSuccess-unique';
 import { StepOnFailureUnique } from './step-onFailure-unique';
 import { RequestBodyReplacementsUnique } from './requestBody-replacements-unique';
 import { NoCriteriaXpath } from '../spot/no-criteria-xpath';
-import { NoActionsTypeEnd } from '../spot/no-actions-type-end';
 import { CriteriaUnique } from './criteria-unique';
 
 import type { Arazzo1Rule } from '../../visitors';
@@ -22,9 +20,8 @@ import type { Arazzo1RuleSet } from '../../oas-types';
 export const rules: Arazzo1RuleSet<'built-in'> = {
   struct: Struct as Arazzo1Rule,
   assertions: Assertions as Arazzo1Rule,
-  'parameters-not-in-body': ParametersNotInBody,
   'sourceDescription-type': SourceDescriptionType,
-  'version-enum': VersionEnum,
+  'spot-supported-versions': SpotSupportedVersions,
   'workflowId-unique': WorkflowIdUnique,
   'stepId-unique': StepIdUnique,
   'sourceDescription-name-unique': SourceDescriptionsNameUnique,
@@ -35,7 +32,6 @@ export const rules: Arazzo1RuleSet<'built-in'> = {
   'step-onFailure-unique': StepOnFailureUnique,
   'requestBody-replacements-unique': RequestBodyReplacementsUnique,
   'no-criteria-xpath': NoCriteriaXpath,
-  'no-actions-type-end': NoActionsTypeEnd,
   'criteria-unique': CriteriaUnique,
 };
 

package/src/rules/spot/{version-enum.ts → spot-supported-versions.ts}

@@ -4,7 +4,7 @@ import { pluralize } from '../../utils';
 import type { Arazzo1Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
 
-export const VersionEnum: Arazzo1Rule = () => {
+export const SpotSupportedVersions: Arazzo1Rule = () => {
   const supportedVersions = ARAZZO_VERSIONS_SUPPORTED_BY_SPOT.join(', ');
   return {
     Root: {

package/src/types/redocly-yaml.ts

@@ -141,9 +141,7 @@ export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
 export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
 
 const builtInArazzo1Rules = [
-  'parameters-not-in-body',
   'sourceDescription-type',
-  'version-enum',
   'workflowId-unique',
   'stepId-unique',
   'sourceDescription-name-unique',
@@ -152,9 +150,9 @@ const builtInArazzo1Rules = [
   'parameters-unique',
   'step-onSuccess-unique',
   'step-onFailure-unique',
+  'spot-supported-versions',
   'requestBody-replacements-unique',
   'no-criteria-xpath',
-  'no-actions-type-end',
   'criteria-unique',
 ] as const;
 

package/src/visitors.ts

@@ -97,6 +97,7 @@ type VisitFunctionOrObject<T> = VisitFunction<T> | VisitObject<T>;
 export type VisitorNode<T> = {
   ruleId: string;
   severity: ProblemSeverity;
+  message?: string;
   context: VisitorLevelContext | VisitorSkippedLevelContext;
   depth: number;
   visit: VisitFunction<T>;
@@ -106,6 +107,7 @@ export type VisitorNode<T> = {
 type VisitorRefNode = {
   ruleId: string;
   severity: ProblemSeverity;
+  message?: string;
   context: VisitorLevelContext;
   depth: number;
   visit: VisitRefFunction;
@@ -365,6 +367,7 @@ export type OasDecorator = Oas3Decorator;
 export type RuleInstanceConfig = {
   ruleId: string;
   severity: ProblemSeverity;
+  message?: string;
 };
 
 export function normalizeVisitors<T extends BaseVisitor>(
@@ -390,8 +393,8 @@ export function normalizeVisitors<T extends BaseVisitor>(
     leave: [],
   };
 
-  for (const { ruleId, severity, visitor } of visitorsConfig) {
-    normalizeVisitorLevel({ ruleId, severity }, visitor, null);
+  for (const { ruleId, severity, message, visitor } of visitorsConfig) {
+    normalizeVisitorLevel({ ruleId, severity, message }, visitor, null);
   }
 
   for (const v of Object.keys(normalizedVisitors)) {

package/src/walk.ts

@@ -165,9 +165,9 @@ export function walkDocument<T extends BaseVisitor>(opts: {
 
     if (isRef(node)) {
       const refEnterVisitors = normalizedVisitors.ref.enter;
-      for (const { visit: visitor, ruleId, severity, context } of refEnterVisitors) {
+      for (const { visit: visitor, ruleId, severity, message, context } of refEnterVisitors) {
         enteredContexts.add(context);
-        const report = reportFn.bind(undefined, ruleId, severity);
+        const report = reportFn.bind(undefined, ruleId, severity, message);
         visitor(
           node,
           {
@@ -203,7 +203,7 @@ export function walkDocument<T extends BaseVisitor>(opts: {
 
       const activatedContexts: Array<VisitorSkippedLevelContext | VisitorLevelContext> = [];
 
-      for (const { context, visit, skip, ruleId, severity } of currentEnterVisitors) {
+      for (const { context, visit, skip, ruleId, severity, message } of currentEnterVisitors) {
         if (ignoredNodes.has(`${currentLocation.absolutePointer}${currentLocation.pointer}`)) break;
 
         if (context.isSkippedLevel) {
@@ -258,7 +258,7 @@ export function walkDocument<T extends BaseVisitor>(opts: {
             if (!activatedOn.skipped) {
               visitedBySome = true;
               enteredContexts.add(context);
-              visitWithContext(visit, resolvedNode, node, context, ruleId, severity);
+              visitWithContext(visit, resolvedNode, node, context, ruleId, severity, message);
             }
           }
         }
@@ -360,9 +360,9 @@ export function walkDocument<T extends BaseVisitor>(opts: {
         }
       }
 
-      for (const { context, visit, ruleId, severity } of currentLeaveVisitors) {
+      for (const { context, visit, ruleId, severity, message } of currentLeaveVisitors) {
         if (!context.isSkippedLevel && enteredContexts.has(context)) {
-          visitWithContext(visit, resolvedNode, node, context, ruleId, severity);
+          visitWithContext(visit, resolvedNode, node, context, ruleId, severity, message);
         }
       }
     }
@@ -371,9 +371,9 @@ export function walkDocument<T extends BaseVisitor>(opts: {
 
     if (isRef(node)) {
       const refLeaveVisitors = normalizedVisitors.ref.leave;
-      for (const { visit: visitor, ruleId, severity, context } of refLeaveVisitors) {
+      for (const { visit: visitor, ruleId, severity, context, message } of refLeaveVisitors) {
         if (enteredContexts.has(context)) {
-          const report = reportFn.bind(undefined, ruleId, severity);
+          const report = reportFn.bind(undefined, ruleId, severity, message);
           visitor(
             node,
             {
@@ -402,9 +402,10 @@ export function walkDocument<T extends BaseVisitor>(opts: {
       node: unknown,
       context: VisitorLevelContext,
       ruleId: string,
-      severity: ProblemSeverity
+      severity: ProblemSeverity,
+      customMessage: string | undefined
     ) {
-      const report = reportFn.bind(undefined, ruleId, severity);
+      const report = reportFn.bind(undefined, ruleId, severity, customMessage);
       visit(
         resolvedNode,
         {
@@ -428,7 +429,12 @@ export function walkDocument<T extends BaseVisitor>(opts: {
       );
     }
 
-    function reportFn(ruleId: string, severity: ProblemSeverity, opts: Problem) {
+    function reportFn(
+      ruleId: string,
+      severity: ProblemSeverity,
+      customMessage: string,
+      opts: Problem
+    ) {
       const normalizedLocation = opts.location
         ? Array.isArray(opts.location)
           ? opts.location
@@ -445,6 +451,9 @@ export function walkDocument<T extends BaseVisitor>(opts: {
           ruleId: opts.ruleId || ruleId,
           severity: ruleSeverity,
           ...opts,
+          message: customMessage
+            ? customMessage.replace('{{message}}', opts.message)
+            : opts.message,
           suggest: opts.suggest || [],
           location,
         });