@redocly/openapi-core 1.25.14 → 1.26.0

package/src/config/recommended.ts

@@ -2,54 +2,70 @@ import type { PluginStyleguideConfig } from './types';
 
 const recommended: PluginStyleguideConfig<'built-in'> = {
   rules: {
+    struct: 'error',
+  },
+  oas2Rules: {
+    'boolean-parameter-prefixes': 'off',
     'info-contact': 'off',
     'info-license': 'warn',
     'info-license-url': 'off',
     'info-license-strict': 'warn',
-    'tag-description': 'warn',
-    'tags-alphabetical': 'off',
-    'parameter-description': 'off',
     'no-path-trailing-slash': 'error',
     'no-identical-paths': 'error',
     'no-ambiguous-paths': 'warn',
-    'path-declaration-must-exist': 'error',
-    'path-not-include-query': 'error',
-    'path-parameters-defined': 'error',
+    'no-invalid-schema-examples': 'off',
+    'no-invalid-parameter-examples': 'off',
+    'no-http-verbs-in-paths': 'off',
+    'no-enum-type-mismatch': 'error',
+    'no-unresolved-refs': 'error',
+    'no-required-schema-properties-undefined': 'off',
+    'operation-summary': 'error',
     'operation-description': 'off',
-    'operation-2xx-response': 'warn',
-    'operation-4xx-response': 'warn',
     'operation-operationId': 'warn',
-    'operation-summary': 'error',
     'operation-operationId-unique': 'error',
     'operation-operationId-url-safe': 'error',
+    'operation-2xx-response': 'warn',
+    'operation-4xx-response': 'warn',
     'operation-parameters-unique': 'error',
     'operation-tag-defined': 'off',
-    'security-defined': 'error',
     'operation-singular-tag': 'off',
-    'no-unresolved-refs': 'error',
-    'no-enum-type-mismatch': 'error',
+    'parameter-description': 'off',
+    'path-declaration-must-exist': 'error',
+    'path-not-include-query': 'error',
+    'path-parameters-defined': 'error',
     'paths-kebab-case': 'off',
-    spec: 'error',
-    'spec-strict-refs': 'off',
-    'no-http-verbs-in-paths': 'off',
-    'no-invalid-parameter-examples': 'off',
-    'no-invalid-schema-examples': 'off',
     'path-excludes-patterns': 'off',
     'path-http-verbs-order': 'off',
     'path-params-defined': 'off',
     'path-segment-plural': 'off',
     'required-string-property-missing-min-length': 'off',
     'response-contains-header': 'off',
-    'scalar-property-missing-example': 'off',
-    'no-required-schema-properties-undefined': 'off',
-  },
-  oas2Rules: {
-    'boolean-parameter-prefixes': 'off',
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
+    'security-defined': 'error',
+    'spec-strict-refs': 'off',
+    'scalar-property-missing-example': 'off',
+    'tag-description': 'warn',
+    'tags-alphabetical': 'off',
   },
   oas3_0Rules: {
+    'array-parameter-serialization': 'off',
+    'boolean-parameter-prefixes': 'off',
+    'component-name-unique': 'off',
+    'info-contact': 'off',
+    'info-license': 'warn',
+    'info-license-url': 'off',
+    'info-license-strict': 'warn',
+    'no-path-trailing-slash': 'error',
+    'no-identical-paths': 'error',
+    'no-ambiguous-paths': 'warn',
+    'no-invalid-schema-examples': 'off',
+    'no-invalid-parameter-examples': 'off',
+    'no-http-verbs-in-paths': 'off',
+    'no-enum-type-mismatch': 'error',
+    'no-unresolved-refs': 'error',
+    'no-required-schema-properties-undefined': 'off',
     'no-invalid-media-type-examples': {
       severity: 'warn',
       allowAdditionalProperties: false,
@@ -61,16 +77,55 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'no-unused-components': 'warn',
     'no-undefined-server-variable': 'error',
     'no-server-variables-empty-enum': 'error',
-    'spec-components-invalid-map-name': 'error',
-    'boolean-parameter-prefixes': 'off',
-    'component-name-unique': 'off',
+    'operation-summary': 'error',
+    'operation-operationId': 'warn',
+    'operation-operationId-unique': 'error',
+    'operation-operationId-url-safe': 'error',
+    'operation-description': 'off',
+    'operation-2xx-response': 'warn',
+    'operation-4xx-response': 'warn',
     'operation-4xx-problem-details-rfc7807': 'off',
+    'operation-parameters-unique': 'error',
+    'operation-tag-defined': 'off',
+    'operation-singular-tag': 'off',
+    'parameter-description': 'off',
+    'path-declaration-must-exist': 'error',
+    'path-not-include-query': 'error',
+    'path-parameters-defined': 'error',
+    'paths-kebab-case': 'off',
+    'path-excludes-patterns': 'off',
+    'path-http-verbs-order': 'off',
+    'path-params-defined': 'off',
+    'path-segment-plural': 'off',
+    'required-string-property-missing-min-length': 'off',
+    'response-contains-header': 'off',
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
-    'array-parameter-serialization': 'off',
+    'security-defined': 'error',
+    'spec-strict-refs': 'off',
+    'scalar-property-missing-example': 'off',
+    'spec-components-invalid-map-name': 'error',
+    'tag-description': 'warn',
+    'tags-alphabetical': 'off',
   },
   oas3_1Rules: {
+    'array-parameter-serialization': 'off',
+    'boolean-parameter-prefixes': 'off',
+    'component-name-unique': 'off',
+    'info-contact': 'off',
+    'info-license': 'warn',
+    'info-license-url': 'off',
+    'info-license-strict': 'warn',
+    'no-path-trailing-slash': 'error',
+    'no-identical-paths': 'error',
+    'no-ambiguous-paths': 'warn',
+    'no-invalid-schema-examples': 'off',
+    'no-invalid-parameter-examples': 'off',
+    'no-http-verbs-in-paths': 'off',
+    'no-enum-type-mismatch': 'error',
+    'no-unresolved-refs': 'error',
+    'no-required-schema-properties-undefined': 'off',
     'no-invalid-media-type-examples': 'warn',
     'no-server-example.com': 'warn',
     'no-server-trailing-slash': 'error',
@@ -79,51 +134,72 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'no-unused-components': 'warn',
     'no-undefined-server-variable': 'error',
     'no-server-variables-empty-enum': 'error',
-    'spec-components-invalid-map-name': 'error',
-    'boolean-parameter-prefixes': 'off',
-    'component-name-unique': 'off',
+    'operation-summary': 'error',
+    'operation-operationId': 'warn',
+    'operation-operationId-unique': 'error',
+    'operation-operationId-url-safe': 'error',
+    'operation-description': 'off',
+    'operation-2xx-response': 'warn',
+    'operation-4xx-response': 'warn',
     'operation-4xx-problem-details-rfc7807': 'off',
+    'operation-parameters-unique': 'error',
+    'operation-tag-defined': 'off',
+    'operation-singular-tag': 'off',
+    'parameter-description': 'off',
+    'path-declaration-must-exist': 'error',
+    'path-not-include-query': 'error',
+    'path-parameters-defined': 'error',
+    'paths-kebab-case': 'off',
+    'path-excludes-patterns': 'off',
+    'path-http-verbs-order': 'off',
+    'path-params-defined': 'off',
+    'path-segment-plural': 'off',
+    'required-string-property-missing-min-length': 'off',
+    'response-contains-header': 'off',
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
-    'array-parameter-serialization': 'off',
+    'security-defined': 'error',
+    'spec-strict-refs': 'off',
+    'scalar-property-missing-example': 'off',
+    'spec-components-invalid-map-name': 'error',
+    'tag-description': 'warn',
+    'tags-alphabetical': 'off',
   },
   async2Rules: {
-    spec: 'error',
+    'channels-kebab-case': 'off',
     'info-contact': 'off',
     'info-license-strict': 'warn',
+    'no-channel-trailing-slash': 'off',
     'operation-operationId': 'warn',
     'tag-description': 'warn',
     'tags-alphabetical': 'off',
-    'channels-kebab-case': 'off',
-    'no-channel-trailing-slash': 'off',
   },
   async3Rules: {
-    spec: 'error',
+    'channels-kebab-case': 'off',
     'info-contact': 'off',
     'info-license-strict': 'warn',
+    'no-channel-trailing-slash': 'off',
     'operation-operationId': 'warn',
     'tag-description': 'warn',
     'tags-alphabetical': 'off',
-    'channels-kebab-case': 'off',
-    'no-channel-trailing-slash': 'off',
   },
-  arazzoRules: {
-    spec: 'error',
+  arazzo1Rules: {
+    'criteria-unique': 'warn',
+    'no-criteria-xpath': 'warn',
+    'no-actions-type-end': 'warn',
     'parameters-not-in-body': 'warn',
+    'parameters-unique': 'error',
+    'requestBody-replacements-unique': 'warn',
     'sourceDescription-type': 'error',
-    'version-enum': 'warn',
-    'workflowId-unique': 'error',
+    'step-onSuccess-unique': 'warn',
+    'step-onFailure-unique': 'warn',
     'stepId-unique': 'error',
     'sourceDescription-name-unique': 'error',
+    'sourceDescriptions-not-empty': 'error',
+    'version-enum': 'warn',
+    'workflowId-unique': 'error',
     'workflow-dependsOn': 'error',
-    'parameters-unique': 'error',
-    'step-onSuccess-unique': 'warn',
-    'step-onFailure-unique': 'warn',
-    'requestBody-replacements-unique': 'warn',
-    'no-criteria-xpath': 'warn',
-    'no-actions-type-end': 'warn',
-    'criteria-unique': 'warn',
   },
 };
 

package/src/config/rules.ts

@@ -1,7 +1,7 @@
 import { isDefined } from '../utils';
 
 import type {
-  ArazzoRuleSet,
+  Arazzo1RuleSet,
   Async2RuleSet,
   Async3RuleSet,
   Oas2RuleSet,
@@ -18,7 +18,7 @@ type InitializedRule = {
 };
 
 export function initRules(
-  rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | ArazzoRuleSet)[],
+  rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | Arazzo1RuleSet)[],
   config: StyleguideConfig,
   type: 'rules' | 'preprocessors' | 'decorators',
   oasVersion: SpecVersion

package/src/config/spec.ts

@@ -0,0 +1,32 @@
+import type { PluginStyleguideConfig } from './types';
+
+const spec: PluginStyleguideConfig<'built-in'> = {
+  rules: {
+    struct: 'error',
+  },
+  // TODO: populate with spec-related rules similar to `arazzo1Rules`
+  oas2Rules: {},
+  oas3_0Rules: {},
+  oas3_1Rules: {},
+  async2Rules: {},
+  async3Rules: {},
+  arazzo1Rules: {
+    'parameters-not-in-body': 'error',
+    'sourceDescription-type': 'error',
+    'version-enum': 'error',
+    'workflowId-unique': 'error',
+    'stepId-unique': 'error',
+    'sourceDescription-name-unique': 'error',
+    'sourceDescriptions-not-empty': 'error',
+    'workflow-dependsOn': 'error',
+    'parameters-unique': 'error',
+    'step-onSuccess-unique': 'error',
+    'step-onFailure-unique': 'error',
+    'requestBody-replacements-unique': 'error',
+    'no-criteria-xpath': 'error',
+    'no-actions-type-end': 'error',
+    'criteria-unique': 'error',
+  },
+};
+
+export default spec;

package/src/config/types.ts

@@ -15,21 +15,13 @@ import type {
   Async3PreprocessorsSet,
   Async3DecoratorsSet,
   Async3RuleSet,
-  ArazzoRuleSet,
-  ArazzoPreprocessorsSet,
-  ArazzoDecoratorsSet,
+  Arazzo1RuleSet,
+  Arazzo1PreprocessorsSet,
+  Arazzo1DecoratorsSet,
   RuleMap,
 } from '../oas-types';
 import type { NodeType } from '../types';
 import type { SkipFunctionContext } from '../visitors';
-import type {
-  BuiltInAsync2RuleId,
-  BuiltInAsync3RuleId,
-  BuiltInCommonOASRuleId,
-  BuiltInOAS2RuleId,
-  BuiltInOAS3RuleId,
-  BuiltInArazzoRuleId,
-} from '../types/redocly-yaml';
 import type { JSONSchema } from 'json-schema-to-ts';
 
 export type RuleSeverity = ProblemSeverity | 'off';
@@ -58,13 +50,13 @@ export type StyleguideRawConfig<T = undefined> = {
   doNotResolveExamples?: boolean;
   recommendedFallback?: boolean;
 
-  rules?: RuleMap<BuiltInCommonOASRuleId, RuleConfig, T>;
-  oas2Rules?: RuleMap<BuiltInOAS2RuleId, RuleConfig, T>;
-  oas3_0Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
-  oas3_1Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
-  async2Rules?: RuleMap<BuiltInAsync2RuleId, RuleConfig, T>;
-  async3Rules?: RuleMap<BuiltInAsync3RuleId, RuleConfig, T>;
-  arazzoRules?: RuleMap<BuiltInArazzoRuleId, RuleConfig, T>;
+  rules?: RuleMap<string, RuleConfig, T>;
+  oas2Rules?: RuleMap<string, RuleConfig, T>;
+  oas3_0Rules?: RuleMap<string, RuleConfig, T>;
+  oas3_1Rules?: RuleMap<string, RuleConfig, T>;
+  async2Rules?: RuleMap<string, RuleConfig, T>;
+  async3Rules?: RuleMap<string, RuleConfig, T>;
+  arazzo1Rules?: RuleMap<string, RuleConfig, T>;
 
   preprocessors?: Record<string, PreprocessorConfig>;
   oas2Preprocessors?: Record<string, PreprocessorConfig>;
@@ -72,7 +64,7 @@ export type StyleguideRawConfig<T = undefined> = {
   oas3_1Preprocessors?: Record<string, PreprocessorConfig>;
   async2Preprocessors?: Record<string, PreprocessorConfig>;
   async3Preprocessors?: Record<string, PreprocessorConfig>;
-  arazzoPreprocessors?: Record<string, PreprocessorConfig>;
+  arazzo1Preprocessors?: Record<string, PreprocessorConfig>;
 
   decorators?: Record<string, DecoratorConfig>;
   oas2Decorators?: Record<string, DecoratorConfig>;
@@ -80,7 +72,7 @@ export type StyleguideRawConfig<T = undefined> = {
   oas3_1Decorators?: Record<string, DecoratorConfig>;
   async2Decorators?: Record<string, DecoratorConfig>;
   async3Decorators?: Record<string, DecoratorConfig>;
-  arazzoDecorators?: Record<string, DecoratorConfig>;
+  arazzo1Decorators?: Record<string, DecoratorConfig>;
 };
 
 export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
@@ -98,7 +90,7 @@ export type PreprocessorsConfig = {
   oas2?: Oas2PreprocessorsSet;
   async2?: Async2PreprocessorsSet;
   async3?: Async3PreprocessorsSet;
-  arazzo?: ArazzoPreprocessorsSet;
+  arazzo1?: Arazzo1PreprocessorsSet;
 };
 
 export type DecoratorsConfig = {
@@ -106,7 +98,7 @@ export type DecoratorsConfig = {
   oas2?: Oas2DecoratorsSet;
   async2?: Async2DecoratorsSet;
   async3?: Async3DecoratorsSet;
-  arazzo?: ArazzoDecoratorsSet;
+  arazzo1?: Arazzo1DecoratorsSet;
 };
 
 export type TypesExtensionFn = (
@@ -116,14 +108,16 @@ export type TypesExtensionFn = (
 
 export type TypeExtensionsConfig = Partial<Record<SpecMajorVersion, TypesExtensionFn>>;
 
-export type CustomRulesConfig = {
-  oas3?: Oas3RuleSet;
-  oas2?: Oas2RuleSet;
-  async2?: Async2RuleSet;
-  async3?: Async3RuleSet;
-  arazzo?: ArazzoRuleSet;
+export type RulesConfig<T> = {
+  oas3?: Oas3RuleSet<T>;
+  oas2?: Oas2RuleSet<T>;
+  async2?: Async2RuleSet<T>;
+  async3?: Async3RuleSet<T>;
+  arazzo1?: Arazzo1RuleSet<T>;
 };
 
+export type CustomRulesConfig = RulesConfig<undefined>;
+
 export type AssertionContext = Partial<UserContext> & SkipFunctionContext & { node: any };
 
 export type AssertResult = { message?: string; location?: Location };
@@ -135,11 +129,11 @@ export type CustomFunction = (
 
 export type AssertionsConfig = Record<string, CustomFunction>;
 
-export type Plugin = {
+export type Plugin<T = undefined> = {
   id: string;
 
   configs?: Record<string, PluginStyleguideConfig>;
-  rules?: CustomRulesConfig;
+  rules?: RulesConfig<T>;
   preprocessors?: PreprocessorsConfig;
   decorators?: DecoratorsConfig;
   typeExtension?: TypeExtensionsConfig;
@@ -287,18 +281,18 @@ export type RulesFields =
   | 'oas3_1Rules'
   | 'async2Rules'
   | 'async3Rules'
-  | 'arazzoRules'
+  | 'arazzo1Rules'
   | 'preprocessors'
   | 'oas2Preprocessors'
   | 'oas3_0Preprocessors'
   | 'oas3_1Preprocessors'
   | 'async2Preprocessors'
   | 'async3Preprocessors'
-  | 'arazzoPreprocessors'
+  | 'arazzo1Preprocessors'
   | 'decorators'
   | 'oas2Decorators'
   | 'oas3_0Decorators'
   | 'oas3_1Decorators'
   | 'async2Decorators'
   | 'async3Decorators'
-  | 'arazzoDecorators';
+  | 'arazzo1Decorators';

package/src/config/utils.ts

@@ -61,7 +61,7 @@ function extractFlatConfig<
   oas3_1Rules,
   async2Rules,
   async3Rules,
-  arazzoRules,
+  arazzo1Rules,
 
   preprocessors,
   oas2Preprocessors,
@@ -69,7 +69,7 @@ function extractFlatConfig<
   oas3_1Preprocessors,
   async2Preprocessors,
   async3Preprocessors,
-  arazzoPreprocessors,
+  arazzo1Preprocessors,
 
   decorators,
   oas2Decorators,
@@ -77,7 +77,7 @@ function extractFlatConfig<
   oas3_1Decorators,
   async2Decorators,
   async3Decorators,
-  arazzoDecorators,
+  arazzo1Decorators,
 
   ...rawConfigRest
 }: T): {
@@ -94,7 +94,7 @@ function extractFlatConfig<
     oas3_1Rules,
     async2Rules,
     async3Rules,
-    arazzoRules,
+    arazzo1Rules,
 
     preprocessors,
     oas2Preprocessors,
@@ -102,7 +102,7 @@ function extractFlatConfig<
     oas3_1Preprocessors,
     async2Preprocessors,
     async3Preprocessors,
-    arazzoPreprocessors,
+    arazzo1Preprocessors,
 
     decorators,
     oas2Decorators,
@@ -110,7 +110,7 @@ function extractFlatConfig<
     oas3_1Decorators,
     async2Decorators,
     async3Decorators,
-    arazzoDecorators,
+    arazzo1Decorators,
 
     doNotResolveExamples: rawConfigRest.resolve?.doNotResolveExamples,
   };
@@ -169,7 +169,7 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     oas3_1Rules: {},
     async2Rules: {},
     async3Rules: {},
-    arazzoRules: {},
+    arazzo1Rules: {},
 
     preprocessors: {},
     oas2Preprocessors: {},
@@ -177,7 +177,7 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     oas3_1Preprocessors: {},
     async2Preprocessors: {},
     async3Preprocessors: {},
-    arazzoPreprocessors: {},
+    arazzo1Preprocessors: {},
 
     decorators: {},
     oas2Decorators: {},
@@ -185,7 +185,7 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     oas3_1Decorators: {},
     async2Decorators: {},
     async3Decorators: {},
-    arazzoDecorators: {},
+    arazzo1Decorators: {},
 
     plugins: [],
     pluginPaths: [],
@@ -210,8 +210,8 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     assignOnlyExistingConfig(result.async2Rules, rulesConf.rules);
     assignConfig(result.async3Rules, rulesConf.async3Rules);
     assignOnlyExistingConfig(result.async3Rules, rulesConf.rules);
-    assignConfig(result.arazzoRules, rulesConf.arazzoRules);
-    assignOnlyExistingConfig(result.arazzoRules, rulesConf.rules);
+    assignConfig(result.arazzo1Rules, rulesConf.arazzo1Rules);
+    assignOnlyExistingConfig(result.arazzo1Rules, rulesConf.rules);
 
     assignConfig(result.preprocessors, rulesConf.preprocessors);
     assignConfig(result.oas2Preprocessors, rulesConf.oas2Preprocessors);
@@ -224,8 +224,8 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     assignOnlyExistingConfig(result.async2Preprocessors, rulesConf.preprocessors);
     assignConfig(result.async3Preprocessors, rulesConf.async3Preprocessors);
     assignOnlyExistingConfig(result.async3Preprocessors, rulesConf.preprocessors);
-    assignConfig(result.arazzoPreprocessors, rulesConf.arazzoPreprocessors);
-    assignOnlyExistingConfig(result.arazzoPreprocessors, rulesConf.preprocessors);
+    assignConfig(result.arazzo1Preprocessors, rulesConf.arazzo1Preprocessors);
+    assignOnlyExistingConfig(result.arazzo1Preprocessors, rulesConf.preprocessors);
 
     assignConfig(result.decorators, rulesConf.decorators);
     assignConfig(result.oas2Decorators, rulesConf.oas2Decorators);
@@ -238,8 +238,8 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     assignOnlyExistingConfig(result.async2Decorators, rulesConf.decorators);
     assignConfig(result.async3Decorators, rulesConf.async3Decorators);
     assignOnlyExistingConfig(result.async3Decorators, rulesConf.decorators);
-    assignConfig(result.arazzoDecorators, rulesConf.arazzoDecorators);
-    assignOnlyExistingConfig(result.arazzoDecorators, rulesConf.decorators);
+    assignConfig(result.arazzo1Decorators, rulesConf.arazzo1Decorators);
+    assignOnlyExistingConfig(result.arazzo1Decorators, rulesConf.decorators);
 
     result.plugins!.push(...(rulesConf.plugins || []));
     result.pluginPaths!.push(...(rulesConf.pluginPaths || []));
@@ -291,7 +291,8 @@ export function checkForDeprecatedFields(
   deprecatedField: keyof (DeprecatedInRawConfig & RawConfig),
   updatedField: keyof FlatRawConfig | undefined,
   rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig,
-  updatedObject: keyof FlatRawConfig | undefined
+  updatedObject: keyof FlatRawConfig | undefined,
+  link?: string | undefined
 ): void {
   const isDeprecatedFieldInApis =
     rawConfig.apis &&
@@ -301,7 +302,7 @@ export function checkForDeprecatedFields(
     );
 
   if (rawConfig[deprecatedField] && updatedField === null) {
-    showWarningForDeprecatedField(deprecatedField);
+    showWarningForDeprecatedField(deprecatedField, undefined, updatedObject, link);
   }
 
   if (rawConfig[deprecatedField] && updatedField && rawConfig[updatedField]) {
@@ -313,7 +314,7 @@ export function checkForDeprecatedFields(
   }
 
   if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
-    showWarningForDeprecatedField(deprecatedField, updatedField, updatedObject);
+    showWarningForDeprecatedField(deprecatedField, updatedField, updatedObject, link);
   }
 }
 
@@ -323,17 +324,28 @@ export function transformConfig(
   const migratedFields: [
     keyof (DeprecatedInRawConfig & RawConfig),
     keyof FlatRawConfig | undefined,
-    keyof ThemeConfig | undefined
+    keyof ThemeConfig | undefined,
+    string | undefined
   ][] = [
-    ['apiDefinitions', 'apis', undefined],
-    ['referenceDocs', 'openapi', 'theme'],
-    ['lint', undefined, undefined],
-    ['styleguide', undefined, undefined],
-    ['features.openapi', 'openapi', 'theme'],
+    ['apiDefinitions', 'apis', undefined, undefined],
+    ['referenceDocs', 'openapi', 'theme', undefined],
+    [
+      'lint',
+      undefined,
+      undefined,
+      'https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties',
+    ],
+    [
+      'styleguide',
+      undefined,
+      undefined,
+      'https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties',
+    ],
+    ['features.openapi', 'openapi', 'theme', undefined],
   ];
 
-  for (const [deprecatedField, updatedField, updatedObject] of migratedFields) {
-    checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, updatedObject);
+  for (const [deprecatedField, updatedField, updatedObject, link] of migratedFields) {
+    checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, updatedObject, link);
   }
 
   const { apis, apiDefinitions, referenceDocs, lint, ...rest } = rawConfig;

package/src/index.ts

@@ -8,7 +8,7 @@ export {
   pause,
 } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
-export { ArazzoTypes } from './types/arazzo';
+export { Arazzo1Types } from './types/arazzo';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
 export { AsyncApi2Types } from './types/asyncapi2';

package/src/lint.ts

@@ -7,7 +7,7 @@ import { normalizeTypes } from './types';
 import { releaseAjvInstance } from './rules/ajv';
 import { SpecVersion, getMajorSpecVersion, detectSpec, getTypes } from './oas-types';
 import { createConfigTypes } from './types/redocly-yaml';
-import { Spec } from './rules/common/spec';
+import { Struct } from './rules/common/struct';
 import { NoUnresolvedRefs } from './rules/no-unresolved-refs';
 
 import type { StyleguideConfig, Config } from './config';
@@ -15,7 +15,7 @@ import type { Document, ResolvedRefMap } from './resolve';
 import type { ProblemSeverity, WalkContext } from './walk';
 import type { NodeType } from './types';
 import type {
-  ArazzoVisitor,
+  Arazzo1Visitor,
   Async2Visitor,
   Async3Visitor,
   NestedVisitObject,
@@ -71,7 +71,7 @@ export async function lintDocument(opts: {
   const { document, customTypes, externalRefResolver, config } = opts;
   const specVersion = detectSpec(document.parsed);
   const specMajorVersion = getMajorSpecVersion(specVersion);
-  const rules = config.getRulesForOasVersion(specMajorVersion);
+  const rules = config.getRulesForSpecVersion(specMajorVersion);
   const types = normalizeTypes(
     config.extendTypes(customTypes ?? getTypes(specVersion), specVersion),
     config
@@ -152,14 +152,14 @@ export async function lintConfig(opts: {
       | Async2Visitor[]
       | Async3Visitor
       | Async3Visitor[]
-      | ArazzoVisitor
-      | ArazzoVisitor[]
+      | Arazzo1Visitor
+      | Arazzo1Visitor[]
     >;
   })[] = [
     {
       severity: severity || 'error',
       ruleId: 'configuration spec',
-      visitor: Spec({ severity: 'error' }),
+      visitor: Struct({ severity: 'error' }),
     },
     {
       severity: severity || 'error',