@redocly/openapi-core 1.31.3 → 1.32.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @redocly/openapi-core
 
+## 1.32.1
+
+### Patch Changes
+
+- Fixed the `x-example` property in Swagger 2.0 to accept any data type, rather than requiring it to be an object.
+
+## 1.32.0
+
+### Minor Changes
+
+- Added support for linting, preprocessors, decorators, and type extensions for Overlay v1 documents.
+
+### Patch Changes
+
+- Updated OAS3 Schema type definition to correct `type` keyword enum, removed `null`.
+
 ## 1.31.3
 
 ### Patch Changes

package/lib/bundle.js

@@ -211,6 +211,11 @@ function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
+        case oas_types_1.SpecMajorVersion.Overlay1:
+            switch (typeName) {
+                default:
+                    return null;
+            }
     }
 }
 function replaceRef(ref, resolved, ctx) {

package/lib/config/all.js

@@ -226,5 +226,8 @@ const all = {
         'workflowId-unique': 'error',
         'workflow-dependsOn': 'error',
     },
+    overlay1Rules: {
+        'info-contact': 'error',
+    },
 };
 exports.default = all;

package/lib/config/builtIn.js

@@ -11,11 +11,13 @@ const oas2_1 = require("../rules/oas2");
 const async2_1 = require("../rules/async2");
 const async3_1 = require("../rules/async3");
 const arazzo_1 = require("../rules/arazzo");
+const overlay1_1 = require("../rules/overlay1");
 const oas3_2 = require("../decorators/oas3");
 const oas2_2 = require("../decorators/oas2");
 const async2_2 = require("../decorators/async2");
 const async3_2 = require("../decorators/async3");
 const arazzo_2 = require("../decorators/arazzo");
+const overlay1_2 = require("../decorators/overlay1");
 exports.builtInConfigs = {
     recommended: recommended_1.default,
     'recommended-strict': recommended_strict_1.default,
@@ -34,6 +36,7 @@ exports.defaultPlugin = {
         async2: async2_1.rules,
         async3: async3_1.rules,
         arazzo1: arazzo_1.rules,
+        overlay1: overlay1_1.rules,
     },
     preprocessors: {
         oas3: oas3_1.preprocessors,
@@ -41,6 +44,7 @@ exports.defaultPlugin = {
         async2: async2_1.preprocessors,
         async3: async3_1.preprocessors,
         arazzo1: arazzo_1.preprocessors,
+        overlay1: overlay1_1.preprocessors,
     },
     decorators: {
         oas3: oas3_2.decorators,
@@ -48,6 +52,7 @@ exports.defaultPlugin = {
         async2: async2_2.decorators,
         async3: async3_2.decorators,
         arazzo1: arazzo_2.decorators,
+        overlay1: overlay1_2.decorators,
     },
     configs: exports.builtInConfigs,
 };

package/lib/config/config-resolvers.js

@@ -167,8 +167,13 @@ async function resolvePlugins(plugins, configDir = '') {
             ...(pluginModule.typeExtension ? { typeExtension: pluginModule.typeExtension } : {}),
         };
         if (pluginModule.rules) {
-            if (!pluginModule.rules.oas3 && !pluginModule.rules.oas2 && !pluginModule.rules.async2) {
-                throw new Error(`Plugin rules must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\` or \`arazzo\` rules "${p}.`);
+            if (!pluginModule.rules.oas3 &&
+                !pluginModule.rules.oas2 &&
+                !pluginModule.rules.async2 &&
+                !pluginModule.rules.async3 &&
+                !pluginModule.rules.arazzo1 &&
+                !pluginModule.rules.overlay1) {
+                throw new Error(`Plugin rules must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\`, \`arazzo\`, or \`overlay1\` rules "${p}.`);
             }
             plugin.rules = {};
             if (pluginModule.rules.oas3) {
@@ -186,14 +191,18 @@ async function resolvePlugins(plugins, configDir = '') {
             if (pluginModule.rules.arazzo1) {
                 plugin.rules.arazzo1 = (0, utils_2.prefixRules)(pluginModule.rules.arazzo1, id);
             }
+            if (pluginModule.rules.overlay1) {
+                plugin.rules.overlay1 = (0, utils_2.prefixRules)(pluginModule.rules.overlay1, id);
+            }
         }
         if (pluginModule.preprocessors) {
             if (!pluginModule.preprocessors.oas3 &&
                 !pluginModule.preprocessors.oas2 &&
                 !pluginModule.preprocessors.async2 &&
                 !pluginModule.preprocessors.async3 &&
-                !pluginModule.preprocessors.arazzo1) {
-                throw new Error(`Plugin \`preprocessors\` must have \`oas3\`, \`oas2\` or \`async2\` preprocessors "${p}.`);
+                !pluginModule.preprocessors.arazzo1 &&
+                !pluginModule.preprocessors.overlay1) {
+                throw new Error(`Plugin \`preprocessors\` must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\`, \`arazzo1\`, or \`overlay1\` preprocessors "${p}.`);
             }
             plugin.preprocessors = {};
             if (pluginModule.preprocessors.oas3) {
@@ -211,14 +220,18 @@ async function resolvePlugins(plugins, configDir = '') {
             if (pluginModule.preprocessors.arazzo1) {
                 plugin.preprocessors.arazzo1 = (0, utils_2.prefixRules)(pluginModule.preprocessors.arazzo1, id);
             }
+            if (pluginModule.preprocessors.overlay1) {
+                plugin.preprocessors.overlay1 = (0, utils_2.prefixRules)(pluginModule.preprocessors.overlay1, id);
+            }
         }
         if (pluginModule.decorators) {
             if (!pluginModule.decorators.oas3 &&
                 !pluginModule.decorators.oas2 &&
                 !pluginModule.decorators.async2 &&
                 !pluginModule.decorators.async3 &&
-                !pluginModule.decorators.arazzo1) {
-                throw new Error(`Plugin \`decorators\` must have \`oas3\`, \`oas2\`, \`async2\` or \`async3\` decorators "${p}.`);
+                !pluginModule.decorators.arazzo1 &&
+                !pluginModule.decorators.overlay1) {
+                throw new Error(`Plugin \`decorators\` must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\`, \`arazzo1\`, or \`overlay1\` decorators "${p}.`);
             }
             plugin.decorators = {};
             if (pluginModule.decorators.oas3) {
@@ -236,6 +249,9 @@ async function resolvePlugins(plugins, configDir = '') {
             if (pluginModule.decorators.arazzo1) {
                 plugin.decorators.arazzo1 = (0, utils_2.prefixRules)(pluginModule.decorators.arazzo1, id);
             }
+            if (pluginModule.decorators.overlay1) {
+                plugin.decorators.overlay1 = (0, utils_2.prefixRules)(pluginModule.decorators.overlay1, id);
+            }
         }
         if (pluginModule.assertions) {
             plugin.assertions = pluginModule.assertions;
@@ -359,6 +375,10 @@ function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig)
         async2Rules: { ...rootStyleguideConfig?.async2Rules, ...apiStyleguideConfig?.async2Rules },
         async3Rules: { ...rootStyleguideConfig?.async3Rules, ...apiStyleguideConfig?.async3Rules },
         arazzo1Rules: { ...rootStyleguideConfig?.arazzo1Rules, ...apiStyleguideConfig?.arazzo1Rules },
+        overlay1Rules: {
+            ...rootStyleguideConfig?.overlay1Rules,
+            ...apiStyleguideConfig?.overlay1Rules,
+        },
         preprocessors: {
             ...rootStyleguideConfig?.preprocessors,
             ...apiStyleguideConfig?.preprocessors,
@@ -375,6 +395,10 @@ function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig)
             ...rootStyleguideConfig?.oas3_1Preprocessors,
             ...apiStyleguideConfig?.oas3_1Preprocessors,
         },
+        overlay1Preprocessors: {
+            ...rootStyleguideConfig?.overlay1Preprocessors,
+            ...apiStyleguideConfig?.overlay1Preprocessors,
+        },
         decorators: { ...rootStyleguideConfig?.decorators, ...apiStyleguideConfig?.decorators },
         oas2Decorators: {
             ...rootStyleguideConfig?.oas2Decorators,
@@ -388,6 +412,10 @@ function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig)
             ...rootStyleguideConfig?.oas3_1Decorators,
             ...apiStyleguideConfig?.oas3_1Decorators,
         },
+        overlay1Decorators: {
+            ...rootStyleguideConfig?.overlay1Decorators,
+            ...apiStyleguideConfig?.overlay1Decorators,
+        },
         recommendedFallback: apiStyleguideConfig?.extends
             ? false
             : rootStyleguideConfig.recommendedFallback,

package/lib/config/config.d.ts

@@ -1,6 +1,6 @@
 import { SpecVersion, SpecMajorVersion } from '../oas-types';
 import type { NormalizedProblem } from '../walk';
-import type { Oas2RuleSet, Oas3RuleSet, Async3RuleSet, Arazzo1RuleSet } from '../oas-types';
+import type { Oas2RuleSet, Oas3RuleSet, Async3RuleSet, Arazzo1RuleSet, Overlay1RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
 import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedStyleguideConfig, RuleConfig, RuleSettings, Telemetry, ThemeRawConfig } from './types';
 export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
@@ -32,7 +32,7 @@ export declare class StyleguideConfig {
         preprocessors: string[];
         decorators: string[];
     };
-    getRulesForSpecVersion(version: SpecMajorVersion): Oas3RuleSet[] | Oas2RuleSet[] | Async3RuleSet[] | Arazzo1RuleSet[];
+    getRulesForSpecVersion(version: SpecMajorVersion): Oas3RuleSet[] | Oas2RuleSet[] | Async3RuleSet[] | Arazzo1RuleSet[] | Overlay1RuleSet[];
     skipRules(rules?: string[]): void;
     skipPreprocessors(preprocessors?: string[]): void;
     skipDecorators(decorators?: string[]): void;

package/lib/config/config.js

@@ -40,6 +40,7 @@ class StyleguideConfig {
             'async2Rules',
             'async3Rules',
             'arazzo1Rules',
+            'overlay1Rules',
         ];
         replaceSpecWithStruct(ruleGroups, rawConfig);
         this.rules = {
@@ -49,6 +50,7 @@ class StyleguideConfig {
             [oas_types_1.SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
             [oas_types_1.SpecVersion.Async3]: { ...rawConfig.rules, ...rawConfig.async3Rules },
             [oas_types_1.SpecVersion.Arazzo1]: { ...rawConfig.rules, ...rawConfig.arazzo1Rules },
+            [oas_types_1.SpecVersion.Overlay1]: { ...rawConfig.rules, ...rawConfig.overlay1Rules },
         };
         this.preprocessors = {
             [oas_types_1.SpecVersion.OAS2]: { ...rawConfig.preprocessors, ...rawConfig.oas2Preprocessors },
@@ -57,6 +59,7 @@ class StyleguideConfig {
             [oas_types_1.SpecVersion.Async2]: { ...rawConfig.preprocessors, ...rawConfig.async2Preprocessors },
             [oas_types_1.SpecVersion.Async3]: { ...rawConfig.preprocessors, ...rawConfig.async3Preprocessors },
             [oas_types_1.SpecVersion.Arazzo1]: { ...rawConfig.arazzo1Preprocessors },
+            [oas_types_1.SpecVersion.Overlay1]: { ...rawConfig.preprocessors, ...rawConfig.overlay1Preprocessors },
         };
         this.decorators = {
             [oas_types_1.SpecVersion.OAS2]: { ...rawConfig.decorators, ...rawConfig.oas2Decorators },
@@ -65,6 +68,7 @@ class StyleguideConfig {
             [oas_types_1.SpecVersion.Async2]: { ...rawConfig.decorators, ...rawConfig.async2Decorators },
             [oas_types_1.SpecVersion.Async3]: { ...rawConfig.decorators, ...rawConfig.async3Decorators },
             [oas_types_1.SpecVersion.Arazzo1]: { ...rawConfig.arazzo1Decorators },
+            [oas_types_1.SpecVersion.Overlay1]: { ...rawConfig.decorators, ...rawConfig.overlay1Decorators },
         };
         this.extendPaths = rawConfig.extendPaths || [];
         this.pluginPaths = rawConfig.pluginPaths || [];
@@ -156,6 +160,11 @@ class StyleguideConfig {
                             continue;
                         extendedTypes = plugin.typeExtension.arazzo1(extendedTypes, version);
                         break;
+                    case oas_types_1.SpecVersion.Overlay1:
+                        if (!plugin.typeExtension.overlay1)
+                            continue;
+                        extendedTypes = plugin.typeExtension.overlay1(extendedTypes, version);
+                        break;
                     default:
                         throw new Error('Not implemented');
                 }
@@ -254,6 +263,13 @@ class StyleguideConfig {
                 this.plugins.forEach((p) => p.rules?.arazzo1 && arazzo1Rules.push(p.rules.arazzo1));
                 this.plugins.forEach((p) => p.decorators?.arazzo1 && arazzo1Rules.push(p.decorators.arazzo1));
                 return arazzo1Rules;
+            case oas_types_1.SpecMajorVersion.Overlay1:
+                // eslint-disable-next-line no-case-declarations
+                const overlay1Rules = [];
+                this.plugins.forEach((p) => p.preprocessors?.overlay1 && overlay1Rules.push(p.preprocessors.overlay1));
+                this.plugins.forEach((p) => p.rules?.overlay1 && overlay1Rules.push(p.rules.overlay1));
+                this.plugins.forEach((p) => p.decorators?.overlay1 && overlay1Rules.push(p.decorators.overlay1));
+                return overlay1Rules;
         }
     }
     skipRules(rules) {

package/lib/config/minimal.js

@@ -202,5 +202,8 @@ const minimal = {
         'workflowId-unique': 'error',
         'workflow-dependsOn': 'off',
     },
+    overlay1Rules: {
+        'info-contact': 'off',
+    },
 };
 exports.default = minimal;

package/lib/config/recommended-strict.js

@@ -202,5 +202,8 @@ const recommendedStrict = {
         'workflowId-unique': 'error',
         'workflow-dependsOn': 'error',
     },
+    overlay1Rules: {
+        'info-contact': 'off',
+    },
 };
 exports.default = recommendedStrict;

package/lib/config/recommended.js

@@ -202,5 +202,8 @@ const recommended = {
         'workflowId-unique': 'error',
         'workflow-dependsOn': 'error',
     },
+    overlay1Rules: {
+        'info-contact': 'off',
+    },
 };
 exports.default = recommended;

package/lib/config/rules.d.ts

@@ -1,4 +1,4 @@
-import type { Arazzo1RuleSet, Async2RuleSet, Async3RuleSet, Oas2RuleSet, Oas3RuleSet, SpecVersion } from '../oas-types';
+import type { Arazzo1RuleSet, Async2RuleSet, Async3RuleSet, Oas2RuleSet, Oas3RuleSet, Overlay1RuleSet, 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 | Arazzo1RuleSet)[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: SpecVersion): InitializedRule[];
+export declare function initRules(rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | Arazzo1RuleSet | Overlay1RuleSet)[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: SpecVersion): InitializedRule[];
 export {};

package/lib/config/spec.js

@@ -25,5 +25,8 @@ const spec = {
         'no-criteria-xpath': 'off',
         'criteria-unique': 'error',
     },
+    overlay1Rules: {
+        'info-contact': 'warn',
+    },
 };
 exports.default = spec;

package/lib/config/types.d.ts

@@ -1,6 +1,6 @@
 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, Arazzo1RuleSet, Arazzo1PreprocessorsSet, Arazzo1DecoratorsSet, RuleMap } from '../oas-types';
+import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, Async3PreprocessorsSet, Async3DecoratorsSet, Async3RuleSet, Arazzo1RuleSet, Arazzo1PreprocessorsSet, Arazzo1DecoratorsSet, RuleMap, Overlay1PreprocessorsSet, Overlay1DecoratorsSet, Overlay1RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
 import type { SkipFunctionContext } from '../visitors';
 import type { JSONSchema } from 'json-schema-to-ts';
@@ -27,6 +27,7 @@ export type StyleguideRawConfig<T = undefined> = {
     async2Rules?: RuleMap<string, RuleConfig, T>;
     async3Rules?: RuleMap<string, RuleConfig, T>;
     arazzo1Rules?: RuleMap<string, RuleConfig, T>;
+    overlay1Rules?: RuleMap<string, RuleConfig, T>;
     preprocessors?: Record<string, PreprocessorConfig>;
     oas2Preprocessors?: Record<string, PreprocessorConfig>;
     oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
@@ -34,6 +35,7 @@ export type StyleguideRawConfig<T = undefined> = {
     async2Preprocessors?: Record<string, PreprocessorConfig>;
     async3Preprocessors?: Record<string, PreprocessorConfig>;
     arazzo1Preprocessors?: Record<string, PreprocessorConfig>;
+    overlay1Preprocessors?: Record<string, PreprocessorConfig>;
     decorators?: Record<string, DecoratorConfig>;
     oas2Decorators?: Record<string, DecoratorConfig>;
     oas3_0Decorators?: Record<string, DecoratorConfig>;
@@ -41,6 +43,7 @@ export type StyleguideRawConfig<T = undefined> = {
     async2Decorators?: Record<string, DecoratorConfig>;
     async3Decorators?: Record<string, DecoratorConfig>;
     arazzo1Decorators?: Record<string, DecoratorConfig>;
+    overlay1Decorators?: Record<string, DecoratorConfig>;
 };
 export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
 export type ResolvedStyleguideConfig = PluginStyleguideConfig & {
@@ -56,6 +59,7 @@ export type PreprocessorsConfig = {
     async2?: Async2PreprocessorsSet;
     async3?: Async3PreprocessorsSet;
     arazzo1?: Arazzo1PreprocessorsSet;
+    overlay1?: Overlay1PreprocessorsSet;
 };
 export type DecoratorsConfig = {
     oas3?: Oas3DecoratorsSet;
@@ -63,6 +67,7 @@ export type DecoratorsConfig = {
     async2?: Async2DecoratorsSet;
     async3?: Async3DecoratorsSet;
     arazzo1?: Arazzo1DecoratorsSet;
+    overlay1?: Overlay1DecoratorsSet;
 };
 export type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: SpecVersion) => Record<string, NodeType>;
 export type TypeExtensionsConfig = Partial<Record<SpecMajorVersion, TypesExtensionFn>>;
@@ -72,6 +77,7 @@ export type RulesConfig<T> = {
     async2?: Async2RuleSet<T>;
     async3?: Async3RuleSet<T>;
     arazzo1?: Arazzo1RuleSet<T>;
+    overlay1?: Overlay1RuleSet<T>;
 };
 export type CustomRulesConfig = RulesConfig<undefined>;
 export type AssertionContext = Partial<UserContext> & SkipFunctionContext & {
@@ -185,5 +191,5 @@ export type ThemeRawConfig = {
     openapi?: Record<string, any>;
     mockServer?: Record<string, any>;
 };
-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 type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'async3Rules' | 'arazzo1Rules' | 'overlay1Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'async3Preprocessors' | 'arazzo1Preprocessors' | 'overlay1Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators' | 'async3Decorators' | 'arazzo1Decorators' | 'overlay1Decorators';
 export {};

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, arazzo1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, async3Preprocessors, arazzo1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators, async3Decorators, arazzo1Decorators, ...rawConfigRest }) {
+function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, async2Rules, async3Rules, arazzo1Rules, overlay1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, async3Preprocessors, arazzo1Preprocessors, overlay1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators, async3Decorators, arazzo1Decorators, overlay1Decorators, ...rawConfigRest }) {
     const styleguideConfig = {
         plugins,
         extends: _extends,
@@ -45,6 +45,7 @@ function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_
         async2Rules,
         async3Rules,
         arazzo1Rules,
+        overlay1Rules,
         preprocessors,
         oas2Preprocessors,
         oas3_0Preprocessors,
@@ -52,6 +53,7 @@ function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_
         async2Preprocessors,
         async3Preprocessors,
         arazzo1Preprocessors,
+        overlay1Preprocessors,
         decorators,
         oas2Decorators,
         oas3_0Decorators,
@@ -59,6 +61,7 @@ function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_
         async2Decorators,
         async3Decorators,
         arazzo1Decorators,
+        overlay1Decorators,
         doNotResolveExamples: rawConfigRest.resolve?.doNotResolveExamples,
     };
     if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
@@ -104,6 +107,7 @@ function mergeExtends(rulesConfList) {
         async2Rules: {},
         async3Rules: {},
         arazzo1Rules: {},
+        overlay1Rules: {},
         preprocessors: {},
         oas2Preprocessors: {},
         oas3_0Preprocessors: {},
@@ -111,6 +115,7 @@ function mergeExtends(rulesConfList) {
         async2Preprocessors: {},
         async3Preprocessors: {},
         arazzo1Preprocessors: {},
+        overlay1Preprocessors: {},
         decorators: {},
         oas2Decorators: {},
         oas3_0Decorators: {},
@@ -118,6 +123,7 @@ function mergeExtends(rulesConfList) {
         async2Decorators: {},
         async3Decorators: {},
         arazzo1Decorators: {},
+        overlay1Decorators: {},
         plugins: [],
         pluginPaths: [],
         extendPaths: [],
@@ -139,6 +145,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async3Rules, rulesConf.rules);
         (0, utils_1.assignConfig)(result.arazzo1Rules, rulesConf.arazzo1Rules);
         (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Rules, rulesConf.rules);
+        (0, utils_1.assignConfig)(result.overlay1Rules, rulesConf.overlay1Rules);
+        (0, utils_1.assignOnlyExistingConfig)(result.overlay1Rules, 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);
@@ -152,6 +160,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async3Preprocessors, rulesConf.preprocessors);
         (0, utils_1.assignConfig)(result.arazzo1Preprocessors, rulesConf.arazzo1Preprocessors);
         (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Preprocessors, rulesConf.preprocessors);
+        (0, utils_1.assignConfig)(result.overlay1Preprocessors, rulesConf.overlay1Preprocessors);
+        (0, utils_1.assignOnlyExistingConfig)(result.overlay1Preprocessors, 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);
@@ -165,6 +175,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async3Decorators, rulesConf.decorators);
         (0, utils_1.assignConfig)(result.arazzo1Decorators, rulesConf.arazzo1Decorators);
         (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Decorators, rulesConf.decorators);
+        (0, utils_1.assignConfig)(result.overlay1Decorators, rulesConf.overlay1Decorators);
+        (0, utils_1.assignOnlyExistingConfig)(result.overlay1Decorators, rulesConf.decorators);
         result.plugins.push(...(rulesConf.plugins || []));
         result.pluginPaths.push(...(rulesConf.pluginPaths || []));
         result.extendPaths.push(...new Set(rulesConf.extendPaths));

package/lib/decorators/overlay1/index.d.ts

@@ -0,0 +1 @@
+export declare const decorators: {};

package/lib/decorators/overlay1/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decorators = void 0;
+exports.decorators = {};

package/lib/oas-types.d.ts

@@ -1,19 +1,21 @@
-import type { BuiltInAsync2RuleId, BuiltInAsync3RuleId, BuiltInArazzo1RuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId } from './types/redocly-yaml';
-import type { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule, Async3Preprocessor, Async3Rule, Arazzo1Preprocessor, Arazzo1Rule } from './visitors';
+import type { BuiltInAsync2RuleId, BuiltInAsync3RuleId, BuiltInArazzo1RuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId, BuiltInOverlay1RuleId } from './types/redocly-yaml';
+import type { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule, Async3Preprocessor, Async3Rule, Arazzo1Preprocessor, Arazzo1Rule, Overlay1Preprocessor, Overlay1Rule } from './visitors';
 export declare enum SpecVersion {
     OAS2 = "oas2",
     OAS3_0 = "oas3_0",
     OAS3_1 = "oas3_1",
     Async2 = "async2",
     Async3 = "async3",
-    Arazzo1 = "arazzo1"
+    Arazzo1 = "arazzo1",
+    Overlay1 = "overlay1"
 }
 export declare enum SpecMajorVersion {
     OAS2 = "oas2",
     OAS3 = "oas3",
     Async2 = "async2",
     Async3 = "async3",
-    Arazzo1 = "arazzo1"
+    Arazzo1 = "arazzo1",
+    Overlay1 = "overlay1"
 }
 export type RuleMap<Key extends string, RuleConfig, T> = Record<T extends 'built-in' ? Key : string, RuleConfig>;
 export type Oas3RuleSet<T = undefined> = RuleMap<BuiltInOAS3RuleId | 'struct' | 'assertions', Oas3Rule, T>;
@@ -21,16 +23,19 @@ export type Oas2RuleSet<T = undefined> = RuleMap<BuiltInOAS2RuleId | 'struct' |
 export type Async2RuleSet<T = undefined> = RuleMap<BuiltInAsync2RuleId | 'struct' | 'assertions', Async2Rule, T>;
 export type Async3RuleSet<T = undefined> = RuleMap<BuiltInAsync3RuleId | 'struct' | 'assertions', Async3Rule, T>;
 export type Arazzo1RuleSet<T = undefined> = RuleMap<BuiltInArazzo1RuleId | 'struct' | 'assertions', Arazzo1Rule, T>;
+export type Overlay1RuleSet<T = undefined> = RuleMap<BuiltInOverlay1RuleId | 'struct' | 'assertions', Overlay1Rule, T>;
 export type Oas3PreprocessorsSet = Record<string, Oas3Preprocessor>;
 export type Oas2PreprocessorsSet = Record<string, Oas2Preprocessor>;
 export type Async2PreprocessorsSet = Record<string, Async2Preprocessor>;
 export type Async3PreprocessorsSet = Record<string, Async3Preprocessor>;
 export type Arazzo1PreprocessorsSet = Record<string, Arazzo1Preprocessor>;
+export type Overlay1PreprocessorsSet = Record<string, Overlay1Preprocessor>;
 export type Oas3DecoratorsSet = Record<string, Oas3Preprocessor>;
 export type Oas2DecoratorsSet = Record<string, Oas2Preprocessor>;
 export type Async2DecoratorsSet = Record<string, Async2Preprocessor>;
 export type Async3DecoratorsSet = Record<string, Async3Preprocessor>;
 export type Arazzo1DecoratorsSet = Record<string, Arazzo1Preprocessor>;
+export type Overlay1DecoratorsSet = Record<string, Overlay1Preprocessor>;
 export declare function detectSpec(root: unknown): SpecVersion;
 export declare function getMajorSpecVersion(version: SpecVersion): SpecMajorVersion;
 export declare function getTypes(spec: SpecVersion): Record<string, import("./types").NodeType> | Record<"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", import("./types").NodeType> | Record<"Root" | "Tag" | "TagList" | "ExternalDocs" | "SecurityRequirement" | "SecurityRequirementList" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "ParameterList" | "Operation" | "Example" | "ExamplesMap" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "Server" | "ServerList" | "ServerVariable" | "ServerVariablesMap" | "Callback" | "CallbacksMap" | "RequestBody" | "MediaTypesMap" | "MediaType" | "Encoding" | "EncodingMap" | "HeadersMap" | "Link" | "LinksMap" | "DiscriminatorMapping" | "Discriminator" | "Components" | "NamedExamples" | "NamedRequestBodies" | "NamedHeaders" | "NamedLinks" | "NamedCallbacks" | "ImplicitFlow" | "PasswordFlow" | "ClientCredentials" | "AuthorizationCode" | "OAuth2Flows" | "XUsePkce" | "WebhooksMap", import("./types").NodeType> | Record<"Root" | "Info" | "License" | "Operation" | "Schema" | "SchemaProperties" | "SecurityScheme" | "Components" | "PatternProperties" | "NamedPathItems" | "DependentRequired", import("./types").NodeType>;

package/lib/oas-types.js

@@ -10,6 +10,7 @@ const oas3_1_1 = require("./types/oas3_1");
 const asyncapi2_1 = require("./types/asyncapi2");
 const asyncapi3_1 = require("./types/asyncapi3");
 const arazzo_1 = require("./types/arazzo");
+const overlay_1 = require("./types/overlay");
 const utils_1 = require("./utils");
 const arazzo_2 = require("./typings/arazzo");
 var SpecVersion;
@@ -20,6 +21,7 @@ var SpecVersion;
     SpecVersion["Async2"] = "async2";
     SpecVersion["Async3"] = "async3";
     SpecVersion["Arazzo1"] = "arazzo1";
+    SpecVersion["Overlay1"] = "overlay1";
 })(SpecVersion || (exports.SpecVersion = SpecVersion = {}));
 var SpecMajorVersion;
 (function (SpecMajorVersion) {
@@ -28,6 +30,7 @@ var SpecMajorVersion;
     SpecMajorVersion["Async2"] = "async2";
     SpecMajorVersion["Async3"] = "async3";
     SpecMajorVersion["Arazzo1"] = "arazzo1";
+    SpecMajorVersion["Overlay1"] = "overlay1";
 })(SpecMajorVersion || (exports.SpecMajorVersion = SpecMajorVersion = {}));
 const typesMap = {
     [SpecVersion.OAS2]: oas2_1.Oas2Types,
@@ -36,6 +39,7 @@ const typesMap = {
     [SpecVersion.Async2]: asyncapi2_1.AsyncApi2Types,
     [SpecVersion.Async3]: asyncapi3_1.AsyncApi3Types,
     [SpecVersion.Arazzo1]: arazzo_1.Arazzo1Types,
+    [SpecVersion.Overlay1]: overlay_1.Overlay1Types,
 };
 function detectSpec(root) {
     if (!(0, utils_1.isPlainObject)(root)) {
@@ -68,6 +72,9 @@ function detectSpec(root) {
     if (typeof root.arazzo === 'string' && arazzo_2.VERSION_PATTERN.test(root.arazzo)) {
         return SpecVersion.Arazzo1;
     }
+    if (typeof root.overlay === 'string' && arazzo_2.VERSION_PATTERN.test(root.overlay)) {
+        return SpecVersion.Overlay1;
+    }
     throw new Error(`Unsupported specification`);
 }
 function getMajorSpecVersion(version) {
@@ -83,6 +90,9 @@ function getMajorSpecVersion(version) {
     else if (version === SpecVersion.Arazzo1) {
         return SpecMajorVersion.Arazzo1;
     }
+    else if (version === SpecVersion.Overlay1) {
+        return SpecMajorVersion.Overlay1;
+    }
     else {
         return SpecMajorVersion.OAS3;
     }

package/lib/rules/common/assertions/index.d.ts

@@ -1,5 +1,5 @@
 import type { asserts, AssertionFn } from './asserts';
-import type { Arazzo1Visitor, Async2Visitor, Async3Visitor, Oas2Visitor, Oas3Visitor } from '../../../visitors';
+import type { Arazzo1Visitor, Async2Visitor, Async3Visitor, Oas2Visitor, Oas3Visitor, Overlay1Visitor } from '../../../visitors';
 import type { RuleSeverity } from '../../../config';
 export type AssertionLocators = {
     filterInParentKeys?: (string | number)[];
@@ -24,4 +24,4 @@ export type RawAssertion = AssertionDefinition & {
 export type Assertion = RawAssertion & {
     assertionId: string;
 };
-export declare const Assertions: (opts: Record<string, Assertion>) => (Oas3Visitor | Oas2Visitor | Async2Visitor | Async3Visitor | Arazzo1Visitor)[];
+export declare const Assertions: (opts: Record<string, Assertion>) => (Oas3Visitor | Oas2Visitor | Async2Visitor | Async3Visitor | Arazzo1Visitor | Overlay1Visitor)[];

package/lib/rules/common/struct.d.ts

@@ -1,2 +1,2 @@
-import type { Oas3Rule, Oas2Rule, Async2Rule, Async3Rule, Arazzo1Rule } from '../../visitors';
-export declare const Struct: Oas3Rule | Oas2Rule | Async2Rule | Async3Rule | Arazzo1Rule;
+import type { Oas3Rule, Oas2Rule, Async2Rule, Async3Rule, Arazzo1Rule, Overlay1Rule } from '../../visitors';
+export declare const Struct: Oas3Rule | Oas2Rule | Async2Rule | Async3Rule | Arazzo1Rule | Overlay1Rule;

package/lib/rules/overlay1/index.d.ts

@@ -0,0 +1,3 @@
+import type { Overlay1RuleSet } from '../../oas-types';
+export declare const rules: Overlay1RuleSet<'built-in'>;
+export declare const preprocessors: {};

package/lib/rules/overlay1/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preprocessors = exports.rules = void 0;
+const assertions_1 = require("../common/assertions");
+const info_contact_1 = require("../common/info-contact");
+const struct_1 = require("../common/struct");
+exports.rules = {
+    'info-contact': info_contact_1.InfoContact,
+    struct: struct_1.Struct,
+    assertions: assertions_1.Assertions,
+};
+exports.preprocessors = {};

package/lib/types/oas2.js

@@ -151,7 +151,7 @@ const Parameter = {
         uniqueItems: { type: 'boolean' },
         enum: { type: 'array' },
         multipleOf: { type: 'number' },
-        'x-example': 'Example',
+        'x-example': {}, // any
         'x-examples': 'ExamplesMap',
     },
     required(value) {

package/lib/types/oas3.js

@@ -301,7 +301,7 @@ const Schema = {
         required: { type: 'array', items: { type: 'string' } },
         enum: { type: 'array' },
         type: {
-            enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'],
+            enum: ['object', 'array', 'string', 'number', 'integer', 'boolean'],
         },
         allOf: (0, _1.listOf)('Schema'),
         anyOf: (0, _1.listOf)('Schema'),