@redocly/openapi-core 1.26.1 → 1.27.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @redocly/openapi-core
 
+## 1.27.0
+
+### Minor Changes
+
+- Added the ability to override default problem messages for built-in rules.
+
+### Patch Changes
+
+- Updated Spot validation rules.
+
 ## 1.26.1
 
 ### Patch Changes

package/lib/config/all.js

@@ -210,8 +210,7 @@ const all = {
     },
     arazzo1Rules: {
         'criteria-unique': 'error',
-        'no-criteria-xpath': 'error',
-        'parameters-not-in-body': 'error',
+        'no-criteria-xpath': 'off',
         'parameters-unique': 'error',
         'requestBody-replacements-unique': 'error',
         'sourceDescription-type': 'error',
@@ -220,7 +219,7 @@ const all = {
         '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/lib/config/minimal.js

@@ -187,7 +187,6 @@ const minimal = {
     arazzo1Rules: {
         'criteria-unique': 'off',
         'no-criteria-xpath': 'off',
-        'parameters-not-in-body': 'off',
         'parameters-unique': 'off',
         'requestBody-replacements-unique': 'off',
         'sourceDescription-type': 'off',
@@ -196,7 +195,7 @@ const minimal = {
         '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/lib/config/recommended-strict.js

@@ -186,8 +186,7 @@ const recommendedStrict = {
     },
     arazzo1Rules: {
         'criteria-unique': 'error',
-        'no-criteria-xpath': 'error',
-        'parameters-not-in-body': 'error',
+        'no-criteria-xpath': 'off',
         'parameters-unique': 'error',
         'requestBody-replacements-unique': 'error',
         'sourceDescription-type': 'error',
@@ -196,7 +195,7 @@ const recommendedStrict = {
         '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/lib/config/recommended.js

@@ -186,8 +186,7 @@ const recommended = {
     },
     arazzo1Rules: {
         'criteria-unique': 'warn',
-        'no-criteria-xpath': 'warn',
-        'parameters-not-in-body': 'warn',
+        'no-criteria-xpath': 'off',
         'parameters-unique': 'error',
         'requestBody-replacements-unique': 'warn',
         'sourceDescription-type': 'error',
@@ -196,7 +195,7 @@ const recommended = {
         '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/lib/config/rules.js

@@ -15,16 +15,19 @@ function initRules(rules, config, type, oasVersion) {
             return undefined;
         }
         const severity = ruleSettings.severity;
+        const message = ruleSettings.message;
         const visitors = rule(ruleSettings);
         if (Array.isArray(visitors)) {
             return visitors.map((visitor) => ({
                 severity,
                 ruleId,
+                message,
                 visitor: visitor,
             }));
         }
         return {
             severity,
+            message,
             ruleId,
             visitor: visitors, // note: actually it is only one visitor object
         };

package/lib/config/spec.js

@@ -11,9 +11,8 @@ const spec = {
     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,7 +22,7 @@ const spec = {
         'step-onSuccess-unique': 'error',
         'step-onFailure-unique': 'error',
         'requestBody-replacements-unique': 'error',
-        'no-criteria-xpath': 'error',
+        'no-criteria-xpath': 'off',
         'criteria-unique': 'error',
     },
 };

package/lib/config/types.d.ts

@@ -7,11 +7,10 @@ import type { JSONSchema } from 'json-schema-to-ts';
 export type RuleSeverity = ProblemSeverity | 'off';
 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 | ({
     severity?: ProblemSeverity;
 } & Record<string, any>);

package/lib/rules/arazzo/index.js

@@ -3,10 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.preprocessors = exports.rules = void 0;
 const struct_1 = require("../common/struct");
 const assertions_1 = require("../common/assertions");
-const parameters_not_in_body_1 = require("../spot/parameters-not-in-body");
 const sourceDescription_type_1 = require("../arazzo/sourceDescription-type");
 const sourceDescriptions_not_empty_1 = require("./sourceDescriptions-not-empty");
-const version_enum_1 = require("../spot/version-enum");
+const spot_supported_versions_1 = require("../spot/spot-supported-versions");
 const workflowId_unique_1 = require("./workflowId-unique");
 const stepId_unique_1 = require("./stepId-unique");
 const sourceDescriptions_name_unique_1 = require("./sourceDescriptions-name-unique");
@@ -20,9 +19,8 @@ const criteria_unique_1 = require("./criteria-unique");
 exports.rules = {
     struct: struct_1.Struct,
     assertions: assertions_1.Assertions,
-    'parameters-not-in-body': parameters_not_in_body_1.ParametersNotInBody,
     'sourceDescription-type': sourceDescription_type_1.SourceDescriptionType,
-    'version-enum': version_enum_1.VersionEnum,
+    'spot-supported-versions': spot_supported_versions_1.SpotSupportedVersions,
     'workflowId-unique': workflowId_unique_1.WorkflowIdUnique,
     'stepId-unique': stepId_unique_1.StepIdUnique,
     'sourceDescription-name-unique': sourceDescriptions_name_unique_1.SourceDescriptionsNameUnique,

package/lib/rules/spot/spot-supported-versions.d.ts

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

package/lib/rules/spot/{version-enum.js → spot-supported-versions.js}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VersionEnum = void 0;
+exports.SpotSupportedVersions = void 0;
 const arazzo_1 = require("../../typings/arazzo");
 const utils_1 = require("../../utils");
-const VersionEnum = () => {
+const SpotSupportedVersions = () => {
     const supportedVersions = arazzo_1.ARAZZO_VERSIONS_SUPPORTED_BY_SPOT.join(', ');
     return {
         Root: {
@@ -18,4 +18,4 @@ const VersionEnum = () => {
         },
     };
 };
-exports.VersionEnum = VersionEnum;
+exports.SpotSupportedVersions = SpotSupportedVersions;

package/lib/types/redocly-yaml.d.ts

@@ -9,7 +9,7 @@ declare const builtInAsync2Rules: readonly ["info-contact", "info-license-strict
 declare const builtInAsync3Rules: readonly ["info-contact", "info-license-strict", "operation-operationId", "tag-description", "tags-alphabetical", "channels-kebab-case", "no-channel-trailing-slash"];
 export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
 export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
-declare const builtInArazzo1Rules: readonly ["parameters-not-in-body", "sourceDescription-type", "version-enum", "workflowId-unique", "stepId-unique", "sourceDescription-name-unique", "sourceDescriptions-not-empty", "workflow-dependsOn", "parameters-unique", "step-onSuccess-unique", "step-onFailure-unique", "requestBody-replacements-unique", "no-criteria-xpath", "criteria-unique"];
+declare const builtInArazzo1Rules: readonly ["sourceDescription-type", "workflowId-unique", "stepId-unique", "sourceDescription-name-unique", "sourceDescriptions-not-empty", "workflow-dependsOn", "parameters-unique", "step-onSuccess-unique", "step-onFailure-unique", "spot-supported-versions", "requestBody-replacements-unique", "no-criteria-xpath", "criteria-unique"];
 export type BuiltInArazzo1RuleId = typeof builtInArazzo1Rules[number];
 declare const oas2NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "ParameterItems", "Operation", "Example", "ExamplesMap", "Examples", "Header", "Responses", "Response", "Schema", "Xml", "SchemaProperties", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedSecuritySchemes", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XServer", "XServerList"];
 export type Oas2NodeType = typeof oas2NodeTypesList[number];

package/lib/types/redocly-yaml.js

@@ -128,9 +128,7 @@ const builtInAsync3Rules = [
     'no-channel-trailing-slash',
 ];
 const builtInArazzo1Rules = [
-    'parameters-not-in-body',
     'sourceDescription-type',
-    'version-enum',
     'workflowId-unique',
     'stepId-unique',
     'sourceDescription-name-unique',
@@ -139,6 +137,7 @@ const builtInArazzo1Rules = [
     'parameters-unique',
     'step-onSuccess-unique',
     'step-onFailure-unique',
+    'spot-supported-versions',
     'requestBody-replacements-unique',
     'no-criteria-xpath',
     'criteria-unique',

package/lib/visitors.d.ts

@@ -23,6 +23,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>;
@@ -31,6 +32,7 @@ export type VisitorNode<T> = {
 type VisitorRefNode = {
     ruleId: string;
     severity: ProblemSeverity;
+    message?: string;
     context: VisitorLevelContext;
     depth: number;
     visit: VisitRefFunction;
@@ -219,6 +221,7 @@ export type OasDecorator = Oas3Decorator;
 export type RuleInstanceConfig = {
     ruleId: string;
     severity: ProblemSeverity;
+    message?: string;
 };
 export declare function normalizeVisitors<T extends BaseVisitor>(visitorsConfig: (RuleInstanceConfig & {
     visitor: NestedVisitObject<unknown, T>;

package/lib/visitors.js

@@ -31,8 +31,8 @@ function normalizeVisitors(visitorsConfig, types) {
         enter: [],
         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)) {
         normalizedVisitors[v].enter.sort((a, b) => b.depth - a.depth);

package/lib/walk.js

@@ -54,9 +54,9 @@ function walkDocument(opts) {
         const enteredContexts = new Set();
         if ((0, ref_utils_1.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, {
                     report,
                     resolve,
@@ -82,7 +82,7 @@ function walkDocument(opts) {
             const anyEnterVisitors = normalizedVisitors.any.enter;
             const currentEnterVisitors = anyEnterVisitors.concat(normalizedVisitors[type.name]?.enter || []);
             const activatedContexts = [];
-            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) {
@@ -127,7 +127,7 @@ function walkDocument(opts) {
                         if (!activatedOn.skipped) {
                             visitedBySome = true;
                             enteredContexts.add(context);
-                            visitWithContext(visit, resolvedNode, node, context, ruleId, severity);
+                            visitWithContext(visit, resolvedNode, node, context, ruleId, severity, message);
                         }
                     }
                 }
@@ -209,18 +209,18 @@ function walkDocument(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);
                 }
             }
         }
         currentLocation = location;
         if ((0, ref_utils_1.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, {
                         report,
                         resolve,
@@ -238,8 +238,8 @@ function walkDocument(opts) {
             }
         }
         // returns true ignores all the next visitors on the specific node
-        function visitWithContext(visit, resolvedNode, node, context, ruleId, severity) {
-            const report = reportFn.bind(undefined, ruleId, severity);
+        function visitWithContext(visit, resolvedNode, node, context, ruleId, severity, customMessage) {
+            const report = reportFn.bind(undefined, ruleId, severity, customMessage);
             visit(resolvedNode, {
                 report,
                 resolve,
@@ -257,7 +257,7 @@ function walkDocument(opts) {
                 getVisitorData: getVisitorDataFn.bind(undefined, ruleId),
             }, collectParents(context), context);
         }
-        function reportFn(ruleId, severity, opts) {
+        function reportFn(ruleId, severity, customMessage, opts) {
             const normalizedLocation = opts.location
                 ? Array.isArray(opts.location)
                     ? opts.location
@@ -274,6 +274,9 @@ function walkDocument(opts) {
                     ruleId: opts.ruleId || ruleId,
                     severity: ruleSeverity,
                     ...opts,
+                    message: customMessage
+                        ? customMessage.replace('{{message}}', opts.message)
+                        : opts.message,
                     suggest: opts.suggest || [],
                     location,
                 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.26.1",
+  "version": "1.27.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {

package/src/__tests__/walk.test.ts

@@ -12,6 +12,7 @@ import {
 import { BaseResolver, Document } from '../resolve';
 import { listOf } from '../types';
 import { Oas3RuleSet } from '../oas-types';
+import { createConfig } from '../config';
 
 describe('walk order', () => {
   it('should run visitors', async () => {
@@ -1338,6 +1339,56 @@ describe('context.report', () => {
       ]
     `);
   });
+
+  it('should report errors with custom messages', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        info:
+          license: {}
+        paths: {}
+      `,
+      'foobar.yaml'
+    );
+
+    const config = await createConfig(`
+      rules:
+        info-contact: 
+          message: "MY ERR DESCRIPTION: {{message}}"
+          severity: "error"
+    `);
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: config.styleguide,
+    });
+
+    expect(results).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/info/contact",
+              "reportOnKey": true,
+              "source": Source {
+                "absoluteRef": "foobar.yaml",
+                "body": "openapi: 3.0.0
+      info:
+        license: {}
+      paths: {}",
+                "mimeType": undefined,
+              },
+            },
+          ],
+          "message": "MY ERR DESCRIPTION: Info object should contain \`contact\` field.",
+          "ruleId": "info-contact",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
 });
 
 describe('context.resolve', () => {

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -6,17 +6,16 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "arazzo1Preprocessors": {},
   "arazzo1Rules": {
     "criteria-unique": "warn",
-    "no-criteria-xpath": "warn",
-    "parameters-not-in-body": "warn",
+    "no-criteria-xpath": "off",
     "parameters-unique": "error",
     "requestBody-replacements-unique": "warn",
     "sourceDescription-name-unique": "error",
     "sourceDescription-type": "error",
     "sourceDescriptions-not-empty": "error",
+    "spot-supported-versions": "off",
     "step-onFailure-unique": "warn",
     "step-onSuccess-unique": "warn",
     "stepId-unique": "error",
-    "version-enum": "warn",
     "workflow-dependsOn": "error",
     "workflowId-unique": "error",
   },
@@ -233,17 +232,16 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "arazzo1Preprocessors": {},
   "arazzo1Rules": {
     "criteria-unique": "warn",
-    "no-criteria-xpath": "warn",
-    "parameters-not-in-body": "warn",
+    "no-criteria-xpath": "off",
     "parameters-unique": "error",
     "requestBody-replacements-unique": "warn",
     "sourceDescription-name-unique": "error",
     "sourceDescription-type": "error",
     "sourceDescriptions-not-empty": "error",
+    "spot-supported-versions": "off",
     "step-onFailure-unique": "warn",
     "step-onSuccess-unique": "warn",
     "stepId-unique": "error",
-    "version-enum": "warn",
     "workflow-dependsOn": "error",
     "workflowId-unique": "error",
   },

package/src/config/all.ts

@@ -210,8 +210,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
   },
   arazzo1Rules: {
     'criteria-unique': 'error',
-    'no-criteria-xpath': 'error',
-    'parameters-not-in-body': 'error',
+    'no-criteria-xpath': 'off',
     'parameters-unique': 'error',
     'requestBody-replacements-unique': 'error',
     'sourceDescription-type': 'error',
@@ -220,7 +219,7 @@ const all: 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/minimal.ts

@@ -187,7 +187,6 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
   arazzo1Rules: {
     'criteria-unique': 'off',
     'no-criteria-xpath': 'off',
-    'parameters-not-in-body': 'off',
     'parameters-unique': 'off',
     'requestBody-replacements-unique': 'off',
     'sourceDescription-type': 'off',
@@ -196,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,8 +186,7 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
   },
   arazzo1Rules: {
     'criteria-unique': 'error',
-    'no-criteria-xpath': 'error',
-    'parameters-not-in-body': 'error',
+    'no-criteria-xpath': 'off',
     'parameters-unique': 'error',
     'requestBody-replacements-unique': 'error',
     'sourceDescription-type': 'error',
@@ -196,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,8 +186,7 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
   },
   arazzo1Rules: {
     'criteria-unique': 'warn',
-    'no-criteria-xpath': 'warn',
-    'parameters-not-in-body': 'warn',
+    'no-criteria-xpath': 'off',
     'parameters-unique': 'error',
     'requestBody-replacements-unique': 'warn',
     'sourceDescription-type': 'error',
@@ -196,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,7 +22,7 @@ const spec: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'error',
     'step-onFailure-unique': 'error',
     'requestBody-replacements-unique': 'error',
-    'no-criteria-xpath': '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": [],
         },