@redocly/openapi-core 1.25.15 → 1.26.0

package/lib/config/recommended.js

@@ -2,54 +2,70 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const recommended = {
     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 = {
         '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 = {
         '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',
     },
 };
 exports.default = recommended;

package/lib/config/rules.d.ts

@@ -1,4 +1,4 @@
-import type { ArazzoRuleSet, Async2RuleSet, Async3RuleSet, Oas2RuleSet, Oas3RuleSet, SpecVersion } from '../oas-types';
+import type { Arazzo1RuleSet, Async2RuleSet, Async3RuleSet, Oas2RuleSet, Oas3RuleSet, SpecVersion } from '../oas-types';
 import type { StyleguideConfig } from './config';
 import type { ProblemSeverity } from '../walk';
 type InitializedRule = {
@@ -6,5 +6,5 @@ type InitializedRule = {
     ruleId: string;
     visitor: any;
 };
-export declare function initRules(rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | ArazzoRuleSet)[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: SpecVersion): InitializedRule[];
+export declare function initRules(rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | Arazzo1RuleSet)[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: SpecVersion): InitializedRule[];
 export {};

package/lib/config/spec.d.ts

@@ -0,0 +1,3 @@
+import type { PluginStyleguideConfig } from './types';
+declare const spec: PluginStyleguideConfig<'built-in'>;
+export default spec;

package/lib/config/spec.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const spec = {
+    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',
+    },
+};
+exports.default = spec;

package/lib/config/types.d.ts

@@ -1,9 +1,8 @@
 import type { Location } from '../ref-utils';
 import type { ProblemSeverity, UserContext } from '../walk';
-import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, Async3PreprocessorsSet, Async3DecoratorsSet, Async3RuleSet, ArazzoRuleSet, ArazzoPreprocessorsSet, ArazzoDecoratorsSet, RuleMap } from '../oas-types';
+import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, Async3PreprocessorsSet, Async3DecoratorsSet, Async3RuleSet, 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';
 export type RuleSettings = {
@@ -22,27 +21,27 @@ export type StyleguideRawConfig<T = undefined> = {
     extends?: string[];
     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>;
     oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
     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>;
     oas3_0Decorators?: Record<string, DecoratorConfig>;
     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'>;
 export type ResolvedStyleguideConfig = PluginStyleguideConfig & {
@@ -57,24 +56,25 @@ export type PreprocessorsConfig = {
     oas2?: Oas2PreprocessorsSet;
     async2?: Async2PreprocessorsSet;
     async3?: Async3PreprocessorsSet;
-    arazzo?: ArazzoPreprocessorsSet;
+    arazzo1?: Arazzo1PreprocessorsSet;
 };
 export type DecoratorsConfig = {
     oas3?: Oas3DecoratorsSet;
     oas2?: Oas2DecoratorsSet;
     async2?: Async2DecoratorsSet;
     async3?: Async3DecoratorsSet;
-    arazzo?: ArazzoDecoratorsSet;
+    arazzo1?: Arazzo1DecoratorsSet;
 };
 export type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: SpecVersion) => Record<string, NodeType>;
 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;
 };
@@ -84,10 +84,10 @@ export type AssertResult = {
 };
 export type CustomFunction = (value: any, options: unknown, baseLocation: Location) => AssertResult[];
 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;
@@ -186,5 +186,5 @@ export type ThemeRawConfig = {
     openapi?: Record<string, any>;
     mockServer?: Record<string, any>;
 };
-export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'async3Rules' | 'arazzoRules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'async3Preprocessors' | 'arazzoPreprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators' | 'async3Decorators' | 'arazzoDecorators';
+export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'async3Rules' | 'arazzo1Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'async3Preprocessors' | 'arazzo1Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators' | 'async3Decorators' | 'arazzo1Decorators';
 export {};

package/lib/config/utils.d.ts

@@ -8,7 +8,7 @@ export declare function transformApiDefinitionsToApis(apiDefinitions?: Deprecate
 export declare function prefixRules<T extends Record<string, any>>(rules: T, prefix: string): any;
 export declare function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]): Omit<ResolvedStyleguideConfig, RulesFields> & Required<Pick<ResolvedStyleguideConfig, RulesFields>>;
 export declare function getMergedConfig(config: Config, apiName?: string): Config;
-export declare function checkForDeprecatedFields(deprecatedField: keyof (DeprecatedInRawConfig & RawConfig), updatedField: keyof FlatRawConfig | undefined, rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig, updatedObject: keyof FlatRawConfig | undefined): void;
+export declare function checkForDeprecatedFields(deprecatedField: keyof (DeprecatedInRawConfig & RawConfig), updatedField: keyof FlatRawConfig | undefined, rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig, updatedObject: keyof FlatRawConfig | undefined, link?: string | undefined): void;
 export declare function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig): RawConfig;
 export declare function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig;
 export declare function getUniquePlugins(plugins: Plugin[]): Plugin[];

package/lib/config/utils.js

@@ -34,7 +34,7 @@ function transformApiDefinitionsToApis(apiDefinitions) {
     }
     return apis;
 }
-function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, async2Rules, async3Rules, arazzoRules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, async3Preprocessors, arazzoPreprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators, async3Decorators, arazzoDecorators, ...rawConfigRest }) {
+function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, async2Rules, async3Rules, arazzo1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, async3Preprocessors, arazzo1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators, async3Decorators, arazzo1Decorators, ...rawConfigRest }) {
     const styleguideConfig = {
         plugins,
         extends: _extends,
@@ -44,21 +44,21 @@ function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_
         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,
         doNotResolveExamples: rawConfigRest.resolve?.doNotResolveExamples,
     };
     if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
@@ -103,21 +103,21 @@ function mergeExtends(rulesConfList) {
         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: {},
         plugins: [],
         pluginPaths: [],
         extendPaths: [],
@@ -137,8 +137,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async2Rules, rulesConf.rules);
         (0, utils_1.assignConfig)(result.async3Rules, rulesConf.async3Rules);
         (0, utils_1.assignOnlyExistingConfig)(result.async3Rules, rulesConf.rules);
-        (0, utils_1.assignConfig)(result.arazzoRules, rulesConf.arazzoRules);
-        (0, utils_1.assignOnlyExistingConfig)(result.arazzoRules, rulesConf.rules);
+        (0, utils_1.assignConfig)(result.arazzo1Rules, rulesConf.arazzo1Rules);
+        (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Rules, rulesConf.rules);
         (0, utils_1.assignConfig)(result.preprocessors, rulesConf.preprocessors);
         (0, utils_1.assignConfig)(result.oas2Preprocessors, rulesConf.oas2Preprocessors);
         (0, utils_1.assignOnlyExistingConfig)(result.oas2Preprocessors, rulesConf.preprocessors);
@@ -150,8 +150,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async2Preprocessors, rulesConf.preprocessors);
         (0, utils_1.assignConfig)(result.async3Preprocessors, rulesConf.async3Preprocessors);
         (0, utils_1.assignOnlyExistingConfig)(result.async3Preprocessors, rulesConf.preprocessors);
-        (0, utils_1.assignConfig)(result.arazzoPreprocessors, rulesConf.arazzoPreprocessors);
-        (0, utils_1.assignOnlyExistingConfig)(result.arazzoPreprocessors, rulesConf.preprocessors);
+        (0, utils_1.assignConfig)(result.arazzo1Preprocessors, rulesConf.arazzo1Preprocessors);
+        (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Preprocessors, rulesConf.preprocessors);
         (0, utils_1.assignConfig)(result.decorators, rulesConf.decorators);
         (0, utils_1.assignConfig)(result.oas2Decorators, rulesConf.oas2Decorators);
         (0, utils_1.assignOnlyExistingConfig)(result.oas2Decorators, rulesConf.decorators);
@@ -163,8 +163,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async2Decorators, rulesConf.decorators);
         (0, utils_1.assignConfig)(result.async3Decorators, rulesConf.async3Decorators);
         (0, utils_1.assignOnlyExistingConfig)(result.async3Decorators, rulesConf.decorators);
-        (0, utils_1.assignConfig)(result.arazzoDecorators, rulesConf.arazzoDecorators);
-        (0, utils_1.assignOnlyExistingConfig)(result.arazzoDecorators, rulesConf.decorators);
+        (0, utils_1.assignConfig)(result.arazzo1Decorators, rulesConf.arazzo1Decorators);
+        (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Decorators, rulesConf.decorators);
         result.plugins.push(...(rulesConf.plugins || []));
         result.pluginPaths.push(...(rulesConf.pluginPaths || []));
         result.extendPaths.push(...new Set(rulesConf.extendPaths));
@@ -203,11 +203,11 @@ function getMergedConfig(config, apiName) {
         }, config.configFile)
         : config;
 }
-function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, updatedObject) {
+function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, updatedObject, link) {
     const isDeprecatedFieldInApis = rawConfig.apis &&
         Object.values(rawConfig.apis).some((api) => api[deprecatedField]);
     if (rawConfig[deprecatedField] && updatedField === null) {
-        (0, utils_1.showWarningForDeprecatedField)(deprecatedField);
+        (0, utils_1.showWarningForDeprecatedField)(deprecatedField, undefined, updatedObject, link);
     }
     if (rawConfig[deprecatedField] && updatedField && rawConfig[updatedField]) {
         (0, utils_1.showErrorForDeprecatedField)(deprecatedField, updatedField);
@@ -216,19 +216,29 @@ function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, upda
         (0, utils_1.showErrorForDeprecatedField)(deprecatedField, updatedField, updatedObject);
     }
     if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
-        (0, utils_1.showWarningForDeprecatedField)(deprecatedField, updatedField, updatedObject);
+        (0, utils_1.showWarningForDeprecatedField)(deprecatedField, updatedField, updatedObject, link);
     }
 }
 function transformConfig(rawConfig) {
     const migratedFields = [
-        ['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;
     const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy, getProxyAgent, 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/lib/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi3Types = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.ArazzoTypes = exports.Oas3_1Types = exports.pause = exports.getProxyAgent = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi3Types = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Arazzo1Types = exports.Oas3_1Types = exports.pause = exports.getProxyAgent = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
 exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
@@ -26,7 +26,7 @@ Object.defineProperty(exports, "pause", { enumerable: true, get: function () { r
 var oas3_1_1 = require("./types/oas3_1");
 Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
 var arazzo_1 = require("./types/arazzo");
-Object.defineProperty(exports, "ArazzoTypes", { enumerable: true, get: function () { return arazzo_1.ArazzoTypes; } });
+Object.defineProperty(exports, "Arazzo1Types", { enumerable: true, get: function () { return arazzo_1.Arazzo1Types; } });
 var oas3_1 = require("./types/oas3");
 Object.defineProperty(exports, "Oas3Types", { enumerable: true, get: function () { return oas3_1.Oas3Types; } });
 var oas2_1 = require("./types/oas2");

package/lib/lint.js

@@ -13,7 +13,7 @@ const types_1 = require("./types");
 const ajv_1 = require("./rules/ajv");
 const oas_types_1 = require("./oas-types");
 const redocly_yaml_1 = require("./types/redocly-yaml");
-const spec_1 = require("./rules/common/spec");
+const struct_1 = require("./rules/common/struct");
 const no_unresolved_refs_1 = require("./rules/no-unresolved-refs");
 async function lint(opts) {
     const { ref, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
@@ -41,7 +41,7 @@ async function lintDocument(opts) {
     const { document, customTypes, externalRefResolver, config } = opts;
     const specVersion = (0, oas_types_1.detectSpec)(document.parsed);
     const specMajorVersion = (0, oas_types_1.getMajorSpecVersion)(specVersion);
-    const rules = config.getRulesForOasVersion(specMajorVersion);
+    const rules = config.getRulesForSpecVersion(specMajorVersion);
     const types = (0, types_1.normalizeTypes)(config.extendTypes(customTypes ?? (0, oas_types_1.getTypes)(specVersion), specVersion), config);
     const ctx = {
         problems: [],
@@ -92,7 +92,7 @@ async function lintConfig(opts) {
         {
             severity: severity || 'error',
             ruleId: 'configuration spec',
-            visitor: (0, spec_1.Spec)({ severity: 'error' }),
+            visitor: (0, struct_1.Struct)({ severity: 'error' }),
         },
         {
             severity: severity || 'error',