@redocly/openapi-core 1.31.3 → 1.32.1

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

@@ -11,6 +11,8 @@ export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
 export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
 declare const builtInArazzo1Rules: readonly ["sourceDescription-type", "workflowId-unique", "stepId-unique", "sourceDescription-name-unique", "sourceDescriptions-not-empty", "workflow-dependsOn", "parameters-unique", "step-onSuccess-unique", "step-onFailure-unique", "respect-supported-versions", "requestBody-replacements-unique", "no-criteria-xpath", "criteria-unique"];
 export type BuiltInArazzo1RuleId = typeof builtInArazzo1Rules[number];
+declare const builtInOverlay1Rules: readonly ["info-contact"];
+export type BuiltInOverlay1RuleId = typeof builtInOverlay1Rules[number];
 declare const oas2NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "ParameterItems", "Operation", "Example", "ExamplesMap", "Examples", "Header", "Responses", "Response", "Schema", "Xml", "SchemaProperties", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedSecuritySchemes", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XServer", "XServerList"];
 export type Oas2NodeType = typeof oas2NodeTypesList[number];
 declare const oas3NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "Server", "ServerList", "ServerVariable", "ServerVariablesMap", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "Operation", "Callback", "CallbacksMap", "RequestBody", "MediaTypesMap", "MediaType", "Example", "ExamplesMap", "Encoding", "EncodingMap", "Header", "HeadersMap", "Responses", "Response", "Link", "LinksMap", "Schema", "Xml", "SchemaProperties", "DiscriminatorMapping", "Discriminator", "Components", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedExamples", "NamedRequestBodies", "NamedHeaders", "NamedSecuritySchemes", "NamedLinks", "NamedCallbacks", "ImplicitFlow", "PasswordFlow", "ClientCredentials", "AuthorizationCode", "OAuth2Flows", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XUsePkce", "WebhooksMap"];

package/lib/types/redocly-yaml.js

@@ -144,12 +144,14 @@ const builtInArazzo1Rules = [
     'no-criteria-xpath',
     'criteria-unique',
 ];
+const builtInOverlay1Rules = ['info-contact'];
 const builtInRules = [
     ...builtInOAS2Rules,
     ...builtInOAS3Rules,
     ...builtInAsync2Rules,
     ...builtInAsync3Rules,
     ...builtInArazzo1Rules,
+    ...builtInOverlay1Rules,
     'spec', // TODO: depricated in favor of struct
     'struct',
 ];

package/lib/typings/openapi.d.ts

@@ -303,12 +303,12 @@ export interface Oas3SecurityRequirement {
     [name: string]: string[];
 }
 export interface Oas3SecurityScheme {
-    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect' | 'mutualTLS';
     description?: string;
     name?: string;
     in?: 'query' | 'header' | 'cookie';
     scheme?: string;
-    bearerFormat: string;
+    bearerFormat?: string;
     flows: {
         implicit?: {
             refreshUrl?: string;

package/lib/visitors.d.ts

@@ -7,6 +7,7 @@ import type { Oas2Definition, Oas2Tag, Oas2ExternalDocs, Oas2SecurityRequirement
 import type { Async2Definition } from './typings/asyncapi';
 import type { Async3Definition } from './typings/asyncapi3';
 import type { ArazzoDefinition, ArazzoSourceDescription, CriteriaObject, ExtendedOperation, InfoObject, OnFailureObject, OnSuccessObject, OpenAPISourceDescription, Parameter, Replacement, RequestBody, SourceDescription, Step, Workflow } from './typings/arazzo';
+import type { Overlay1Definition } from './typings/overlay';
 export type SkipFunctionContext = Pick<UserContext, 'location' | 'rawNode' | 'resolve' | 'rawLocation'>;
 export type VisitFunction<T> = (node: T, ctx: UserContext & {
     ignoreNextVisitorsOnNode: () => void;
@@ -164,6 +165,9 @@ type ArazzoFlatVisitor = {
     Workflow?: VisitFunctionOrObject<Workflow>;
     Workflows?: VisitFunctionOrObject<Workflow[]>;
 };
+type Overlay1FlatVisitor = {
+    Root?: VisitFunctionOrObject<Overlay1Definition>;
+};
 type Oas3NestedVisitor = {
     [T in keyof Oas3FlatVisitor]: Oas3FlatVisitor[T] extends Function ? Oas3FlatVisitor[T] : Oas3FlatVisitor[T] & NestedVisitor<Oas3NestedVisitor>;
 };
@@ -179,11 +183,15 @@ type Async3NestedVisitor = {
 type ArazzoNestedVisitor = {
     [T in keyof ArazzoFlatVisitor]: ArazzoFlatVisitor[T] extends Function ? ArazzoFlatVisitor[T] : ArazzoFlatVisitor[T] & NestedVisitor<ArazzoNestedVisitor>;
 };
+type Overlay1NestedVisitor = {
+    [T in keyof Overlay1FlatVisitor]: Overlay1FlatVisitor[T] extends Function ? Overlay1FlatVisitor[T] : Overlay1FlatVisitor[T] & NestedVisitor<Overlay1NestedVisitor>;
+};
 export type Oas3Visitor = BaseVisitor & Oas3NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas3NestedVisitor>>;
 export type Oas2Visitor = BaseVisitor & Oas2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas2NestedVisitor>>;
 export type Async2Visitor = BaseVisitor & Async2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Async2NestedVisitor>>;
 export type Async3Visitor = BaseVisitor & Async3NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Async3NestedVisitor>>;
 export type Arazzo1Visitor = BaseVisitor & ArazzoNestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, ArazzoNestedVisitor>>;
+export type Overlay1Visitor = BaseVisitor & Overlay1NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Overlay1NestedVisitor>>;
 export type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'Root'>;
 export type NormalizedOasVisitors<T extends BaseVisitor> = {
     [V in keyof T]-?: {
@@ -205,16 +213,19 @@ export type Oas2Rule = (options: Record<string, any>) => Oas2Visitor | Oas2Visit
 export type Async2Rule = (options: Record<string, any>) => Async2Visitor | Async2Visitor[];
 export type Async3Rule = (options: Record<string, any>) => Async3Visitor | Async3Visitor[];
 export type Arazzo1Rule = (options: Record<string, any>) => Arazzo1Visitor | Arazzo1Visitor[];
+export type Overlay1Rule = (options: Record<string, any>) => Overlay1Visitor | Overlay1Visitor[];
 export type Oas3Preprocessor = (options: Record<string, any>) => Oas3Visitor;
 export type Oas2Preprocessor = (options: Record<string, any>) => Oas2Visitor;
 export type Async2Preprocessor = (options: Record<string, any>) => Async2Visitor;
 export type Async3Preprocessor = (options: Record<string, any>) => Async3Visitor;
 export type Arazzo1Preprocessor = (options: Record<string, any>) => Arazzo1Visitor;
+export type Overlay1Preprocessor = (options: Record<string, any>) => Overlay1Visitor;
 export type Oas3Decorator = (options: Record<string, any>) => Oas3Visitor;
 export type Oas2Decorator = (options: Record<string, any>) => Oas2Visitor;
 export type Async2Decorator = (options: Record<string, any>) => Async2Visitor;
 export type Async3Decorator = (options: Record<string, any>) => Async3Visitor;
 export type Arazzo1Decorator = (options: Record<string, any>) => Arazzo1Visitor;
+export type Overlay1Decorator = (options: Record<string, any>) => Overlay1Visitor;
 export type OasRule = Oas3Rule;
 export type OasPreprocessor = Oas3Preprocessor;
 export type OasDecorator = Oas3Decorator;

package/package.json

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

package/src/bundle.ts

@@ -311,6 +311,11 @@ export function mapTypeToComponent(typeName: string, version: SpecMajorVersion)
         default:
           return null;
       }
+    case SpecMajorVersion.Overlay1:
+      switch (typeName) {
+        default:
+          return null;
+      }
   }
 }
 

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

@@ -214,6 +214,11 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "overlay1Decorators": {},
+  "overlay1Preprocessors": {},
+  "overlay1Rules": {
+    "info-contact": "off",
+  },
   "preprocessors": {},
   "recommendedFallback": false,
   "rules": {
@@ -443,6 +448,11 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "overlay1Decorators": {},
+  "overlay1Preprocessors": {},
+  "overlay1Rules": {
+    "info-contact": "off",
+  },
   "preprocessors": {},
   "recommendedFallback": undefined,
   "rules": {

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

@@ -32,6 +32,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "overlay1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
   },
   "doNotResolveExamples": false,
   "extendPaths": [],
@@ -76,6 +81,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "overlay1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
   },
   "rawConfig": {
     "_usedRules": Set {},
@@ -203,6 +213,20 @@ StyleguideConfig {
         "operation-summary": "error",
       },
     },
+    "overlay1": {
+      "oas2": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
   },
 }
 `;

package/src/config/__tests__/config.test.ts

@@ -123,6 +123,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "doNotResolveExamples": false,
           "extendPaths": [],
@@ -136,6 +137,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "rawConfig": {
             "extendPaths": [],
@@ -164,6 +166,9 @@ describe('getMergedConfig', () => {
             "oas3_1": {
               "operation-summary": "warn",
             },
+            "overlay1": {
+              "operation-summary": "warn",
+            },
           },
         },
         "telemetry": "on",
@@ -238,6 +243,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "doNotResolveExamples": false,
           "extendPaths": [],
@@ -251,6 +257,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "rawConfig": {
             "extendPaths": [],
@@ -287,6 +294,10 @@ describe('getMergedConfig', () => {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
+            "overlay1": {
+              "no-empty-servers": "error",
+              "operation-summary": "error",
+            },
           },
         },
         "telemetry": "on",

package/src/config/all.ts

@@ -226,6 +226,9 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'error',
   },
+  overlay1Rules: {
+    'info-contact': 'error',
+  },
 };
 
 export default all;

package/src/config/builtIn.ts

@@ -8,11 +8,13 @@ import { rules as oas2Rules, preprocessors as oas2Preprocessors } from '../rules
 import { rules as async2Rules, preprocessors as async2Preprocessors } from '../rules/async2';
 import { rules as async3Rules, preprocessors as async3Preprocessors } from '../rules/async3';
 import { rules as arazzo1Rules, preprocessors as arazzoPreprocessors } from '../rules/arazzo';
+import { rules as overlay1Rules, preprocessors as overlay1Preprocessors } from '../rules/overlay1';
 import { decorators as oas3Decorators } from '../decorators/oas3';
 import { decorators as oas2Decorators } from '../decorators/oas2';
 import { decorators as async2Decorators } from '../decorators/async2';
 import { decorators as async3Decorators } from '../decorators/async3';
 import { decorators as arazzo1Decorators } from '../decorators/arazzo';
+import { decorators as overlay1Decorators } from '../decorators/overlay1';
 
 import type { StyleguideRawConfig, Plugin } from './types';
 
@@ -35,6 +37,7 @@ export const defaultPlugin: Plugin<'built-in'> = {
     async2: async2Rules,
     async3: async3Rules,
     arazzo1: arazzo1Rules,
+    overlay1: overlay1Rules,
   },
   preprocessors: {
     oas3: oas3Preprocessors,
@@ -42,6 +45,7 @@ export const defaultPlugin: Plugin<'built-in'> = {
     async2: async2Preprocessors,
     async3: async3Preprocessors,
     arazzo1: arazzoPreprocessors,
+    overlay1: overlay1Preprocessors,
   },
   decorators: {
     oas3: oas3Decorators,
@@ -49,6 +53,7 @@ export const defaultPlugin: Plugin<'built-in'> = {
     async2: async2Decorators,
     async3: async3Decorators,
     arazzo1: arazzo1Decorators,
+    overlay1: overlay1Decorators,
   },
   configs: builtInConfigs,
 };

package/src/config/config-resolvers.ts

@@ -250,9 +250,16 @@ export async function resolvePlugins(
       };
 
       if (pluginModule.rules) {
-        if (!pluginModule.rules.oas3 && !pluginModule.rules.oas2 && !pluginModule.rules.async2) {
+        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\` or \`arazzo\` rules "${p}.`
+            `Plugin rules must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\`, \`arazzo\`, or \`overlay1\` rules "${p}.`
           );
         }
         plugin.rules = {};
@@ -271,6 +278,9 @@ export async function resolvePlugins(
         if (pluginModule.rules.arazzo1) {
           plugin.rules.arazzo1 = prefixRules(pluginModule.rules.arazzo1, id);
         }
+        if (pluginModule.rules.overlay1) {
+          plugin.rules.overlay1 = prefixRules(pluginModule.rules.overlay1, id);
+        }
       }
       if (pluginModule.preprocessors) {
         if (
@@ -278,10 +288,11 @@ export async function resolvePlugins(
           !pluginModule.preprocessors.oas2 &&
           !pluginModule.preprocessors.async2 &&
           !pluginModule.preprocessors.async3 &&
-          !pluginModule.preprocessors.arazzo1
+          !pluginModule.preprocessors.arazzo1 &&
+          !pluginModule.preprocessors.overlay1
         ) {
           throw new Error(
-            `Plugin \`preprocessors\` must have \`oas3\`, \`oas2\` or \`async2\` preprocessors "${p}.`
+            `Plugin \`preprocessors\` must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\`, \`arazzo1\`, or \`overlay1\` preprocessors "${p}.`
           );
         }
         plugin.preprocessors = {};
@@ -300,6 +311,9 @@ export async function resolvePlugins(
         if (pluginModule.preprocessors.arazzo1) {
           plugin.preprocessors.arazzo1 = prefixRules(pluginModule.preprocessors.arazzo1, id);
         }
+        if (pluginModule.preprocessors.overlay1) {
+          plugin.preprocessors.overlay1 = prefixRules(pluginModule.preprocessors.overlay1, id);
+        }
       }
 
       if (pluginModule.decorators) {
@@ -308,10 +322,11 @@ export async function resolvePlugins(
           !pluginModule.decorators.oas2 &&
           !pluginModule.decorators.async2 &&
           !pluginModule.decorators.async3 &&
-          !pluginModule.decorators.arazzo1
+          !pluginModule.decorators.arazzo1 &&
+          !pluginModule.decorators.overlay1
         ) {
           throw new Error(
-            `Plugin \`decorators\` must have \`oas3\`, \`oas2\`, \`async2\` or \`async3\` decorators "${p}.`
+            `Plugin \`decorators\` must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\`, \`arazzo1\`, or \`overlay1\` decorators "${p}.`
           );
         }
         plugin.decorators = {};
@@ -330,6 +345,9 @@ export async function resolvePlugins(
         if (pluginModule.decorators.arazzo1) {
           plugin.decorators.arazzo1 = prefixRules(pluginModule.decorators.arazzo1, id);
         }
+        if (pluginModule.decorators.overlay1) {
+          plugin.decorators.overlay1 = prefixRules(pluginModule.decorators.overlay1, id);
+        }
       }
 
       if (pluginModule.assertions) {
@@ -520,6 +538,10 @@ function getMergedRawStyleguideConfig(
     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,
@@ -536,6 +558,10 @@ function getMergedRawStyleguideConfig(
       ...rootStyleguideConfig?.oas3_1Preprocessors,
       ...apiStyleguideConfig?.oas3_1Preprocessors,
     },
+    overlay1Preprocessors: {
+      ...rootStyleguideConfig?.overlay1Preprocessors,
+      ...apiStyleguideConfig?.overlay1Preprocessors,
+    },
     decorators: { ...rootStyleguideConfig?.decorators, ...apiStyleguideConfig?.decorators },
     oas2Decorators: {
       ...rootStyleguideConfig?.oas2Decorators,
@@ -549,6 +575,10 @@ function getMergedRawStyleguideConfig(
       ...rootStyleguideConfig?.oas3_1Decorators,
       ...apiStyleguideConfig?.oas3_1Decorators,
     },
+    overlay1Decorators: {
+      ...rootStyleguideConfig?.overlay1Decorators,
+      ...apiStyleguideConfig?.overlay1Decorators,
+    },
     recommendedFallback: apiStyleguideConfig?.extends
       ? false
       : rootStyleguideConfig.recommendedFallback,

package/src/config/config.ts

@@ -14,6 +14,7 @@ import type {
   Async2RuleSet,
   Async3RuleSet,
   Arazzo1RuleSet,
+  Overlay1RuleSet,
 } from '../oas-types';
 import type { NodeType } from '../types';
 import type {
@@ -75,6 +76,7 @@ export class StyleguideConfig {
       'async2Rules',
       'async3Rules',
       'arazzo1Rules',
+      'overlay1Rules',
     ];
 
     replaceSpecWithStruct(ruleGroups, rawConfig);
@@ -86,6 +88,7 @@ export class StyleguideConfig {
       [SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
       [SpecVersion.Async3]: { ...rawConfig.rules, ...rawConfig.async3Rules },
       [SpecVersion.Arazzo1]: { ...rawConfig.rules, ...rawConfig.arazzo1Rules },
+      [SpecVersion.Overlay1]: { ...rawConfig.rules, ...rawConfig.overlay1Rules },
     };
 
     this.preprocessors = {
@@ -95,6 +98,7 @@ export class StyleguideConfig {
       [SpecVersion.Async2]: { ...rawConfig.preprocessors, ...rawConfig.async2Preprocessors },
       [SpecVersion.Async3]: { ...rawConfig.preprocessors, ...rawConfig.async3Preprocessors },
       [SpecVersion.Arazzo1]: { ...rawConfig.arazzo1Preprocessors },
+      [SpecVersion.Overlay1]: { ...rawConfig.preprocessors, ...rawConfig.overlay1Preprocessors },
     };
 
     this.decorators = {
@@ -104,6 +108,7 @@ export class StyleguideConfig {
       [SpecVersion.Async2]: { ...rawConfig.decorators, ...rawConfig.async2Decorators },
       [SpecVersion.Async3]: { ...rawConfig.decorators, ...rawConfig.async3Decorators },
       [SpecVersion.Arazzo1]: { ...rawConfig.arazzo1Decorators },
+      [SpecVersion.Overlay1]: { ...rawConfig.decorators, ...rawConfig.overlay1Decorators },
     };
 
     this.extendPaths = rawConfig.extendPaths || [];
@@ -207,6 +212,10 @@ export class StyleguideConfig {
             if (!plugin.typeExtension.arazzo1) continue;
             extendedTypes = plugin.typeExtension.arazzo1(extendedTypes, version);
             break;
+          case SpecVersion.Overlay1:
+            if (!plugin.typeExtension.overlay1) continue;
+            extendedTypes = plugin.typeExtension.overlay1(extendedTypes, version);
+            break;
           default:
             throw new Error('Not implemented');
         }
@@ -328,6 +337,17 @@ export class StyleguideConfig {
           (p) => p.decorators?.arazzo1 && arazzo1Rules.push(p.decorators.arazzo1)
         );
         return arazzo1Rules;
+      case SpecMajorVersion.Overlay1:
+        // eslint-disable-next-line no-case-declarations
+        const overlay1Rules: Overlay1RuleSet[] = [];
+        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;
     }
   }
 

package/src/config/minimal.ts

@@ -202,6 +202,9 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'off',
   },
+  overlay1Rules: {
+    'info-contact': 'off',
+  },
 };
 
 export default minimal;

package/src/config/recommended-strict.ts

@@ -202,6 +202,9 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'error',
   },
+  overlay1Rules: {
+    'info-contact': 'off',
+  },
 };
 
 export default recommendedStrict;

package/src/config/recommended.ts

@@ -202,6 +202,9 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'error',
   },
+  overlay1Rules: {
+    'info-contact': 'off',
+  },
 };
 
 export default recommended;

package/src/config/rules.ts

@@ -6,6 +6,7 @@ import type {
   Async3RuleSet,
   Oas2RuleSet,
   Oas3RuleSet,
+  Overlay1RuleSet,
   SpecVersion,
 } from '../oas-types';
 import type { StyleguideConfig } from './config';
@@ -18,7 +19,14 @@ type InitializedRule = {
 };
 
 export function initRules(
-  rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | Arazzo1RuleSet)[],
+  rules: (
+    | Oas3RuleSet
+    | Oas2RuleSet
+    | Async2RuleSet
+    | Async3RuleSet
+    | Arazzo1RuleSet
+    | Overlay1RuleSet
+  )[],
   config: StyleguideConfig,
   type: 'rules' | 'preprocessors' | 'decorators',
   oasVersion: SpecVersion

package/src/config/spec.ts

@@ -25,6 +25,9 @@ const spec: PluginStyleguideConfig<'built-in'> = {
     'no-criteria-xpath': 'off',
     'criteria-unique': 'error',
   },
+  overlay1Rules: {
+    'info-contact': 'warn',
+  },
 };
 
 export default spec;

package/src/config/types.ts

@@ -19,6 +19,9 @@ import type {
   Arazzo1PreprocessorsSet,
   Arazzo1DecoratorsSet,
   RuleMap,
+  Overlay1PreprocessorsSet,
+  Overlay1DecoratorsSet,
+  Overlay1RuleSet,
 } from '../oas-types';
 import type { NodeType } from '../types';
 import type { SkipFunctionContext } from '../visitors';
@@ -53,6 +56,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>;
@@ -61,6 +65,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>;
@@ -69,6 +74,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'>;
@@ -87,6 +93,7 @@ export type PreprocessorsConfig = {
   async2?: Async2PreprocessorsSet;
   async3?: Async3PreprocessorsSet;
   arazzo1?: Arazzo1PreprocessorsSet;
+  overlay1?: Overlay1PreprocessorsSet;
 };
 
 export type DecoratorsConfig = {
@@ -95,6 +102,7 @@ export type DecoratorsConfig = {
   async2?: Async2DecoratorsSet;
   async3?: Async3DecoratorsSet;
   arazzo1?: Arazzo1DecoratorsSet;
+  overlay1?: Overlay1DecoratorsSet;
 };
 
 export type TypesExtensionFn = (
@@ -110,6 +118,7 @@ export type RulesConfig<T> = {
   async2?: Async2RuleSet<T>;
   async3?: Async3RuleSet<T>;
   arazzo1?: Arazzo1RuleSet<T>;
+  overlay1?: Overlay1RuleSet<T>;
 };
 
 export type CustomRulesConfig = RulesConfig<undefined>;
@@ -278,6 +287,7 @@ export type RulesFields =
   | 'async2Rules'
   | 'async3Rules'
   | 'arazzo1Rules'
+  | 'overlay1Rules'
   | 'preprocessors'
   | 'oas2Preprocessors'
   | 'oas3_0Preprocessors'
@@ -285,10 +295,12 @@ export type RulesFields =
   | 'async2Preprocessors'
   | 'async3Preprocessors'
   | 'arazzo1Preprocessors'
+  | 'overlay1Preprocessors'
   | 'decorators'
   | 'oas2Decorators'
   | 'oas3_0Decorators'
   | 'oas3_1Decorators'
   | 'async2Decorators'
   | 'async3Decorators'
-  | 'arazzo1Decorators';
+  | 'arazzo1Decorators'
+  | 'overlay1Decorators';