@redocly/openapi-core 1.25.15 → 1.26.1

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

@@ -6,7 +6,7 @@ StyleguideConfig {
   "_usedVersions": Set {},
   "configFile": undefined,
   "decorators": {
-    "arazzo": {},
+    "arazzo1": {},
     "async2": {
       "oas2": {},
       "oas3_0": {},
@@ -50,7 +50,7 @@ StyleguideConfig {
   "pluginPaths": [],
   "plugins": [],
   "preprocessors": {
-    "arazzo": {},
+    "arazzo1": {},
     "async2": {
       "oas2": {},
       "oas3_0": {},
@@ -119,7 +119,20 @@ StyleguideConfig {
   },
   "recommendedFallback": false,
   "rules": {
-    "arazzo": {},
+    "arazzo1": {
+      "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",
+      },
+    },
     "async2": {
       "oas2": {
         "no-empty-servers": "error",

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

@@ -389,11 +389,23 @@ describe('resolveStyleguideConfig', () => {
 
 describe('resolveApis', () => {
   it('should resolve apis styleguideConfig and merge minimal extends', async () => {
+    const baseStyleguideConfig: StyleguideRawConfig = {
+      oas3_1Rules: {
+        'operation-2xx-response': 'error',
+      },
+    };
+    const mergedStyleguidePreset = resolveStyleguideConfig({
+      styleguideConfig: { ...baseStyleguideConfig, extends: ['minimal'] },
+    });
     const rawConfig: RawConfig = {
       apis: {
         petstore: {
           root: 'some/path',
-          styleguide: {},
+          styleguide: {
+            oas3_1Rules: {
+              'operation-2xx-response': 'error',
+            },
+          },
         },
       },
       styleguide: {
@@ -401,7 +413,7 @@ describe('resolveApis', () => {
       },
     };
     const apisResult = await resolveApis({ rawConfig });
-    expect(apisResult['petstore'].styleguide).toEqual(await minimalStyleguidePreset);
+    expect(apisResult['petstore'].styleguide).toEqual(await mergedStyleguidePreset);
   });
 
   it('should not merge recommended extends by default by every level', async () => {

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

@@ -117,7 +117,7 @@ describe('getMergedConfig', () => {
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
           "decorators": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -130,7 +130,7 @@ describe('getMergedConfig', () => {
           "pluginPaths": [],
           "plugins": [],
           "preprocessors": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -146,7 +146,9 @@ describe('getMergedConfig', () => {
           },
           "recommendedFallback": false,
           "rules": {
-            "arazzo": {},
+            "arazzo1": {
+              "operation-summary": "warn",
+            },
             "async2": {
               "operation-summary": "warn",
             },
@@ -230,7 +232,7 @@ describe('getMergedConfig', () => {
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
           "decorators": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -243,7 +245,7 @@ describe('getMergedConfig', () => {
           "pluginPaths": [],
           "plugins": [],
           "preprocessors": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -261,7 +263,10 @@ describe('getMergedConfig', () => {
           },
           "recommendedFallback": false,
           "rules": {
-            "arazzo": {},
+            "arazzo1": {
+              "no-empty-servers": "error",
+              "operation-summary": "error",
+            },
             "async2": {
               "no-empty-servers": "error",
               "operation-summary": "error",

package/src/config/all.ts

@@ -2,52 +2,47 @@ import type { PluginStyleguideConfig } from './types';
 
 const all: PluginStyleguideConfig<'built-in'> = {
   rules: {
+    struct: 'error',
+  },
+  oas2Rules: {
+    'boolean-parameter-prefixes': 'error',
     'info-contact': 'error',
     'info-license': 'error',
     'info-license-url': 'error',
     'info-license-strict': 'error',
-    'tag-description': 'error',
-    'tags-alphabetical': 'error',
-    'parameter-description': 'error',
+    'no-path-trailing-slash': 'error',
     'no-identical-paths': 'error',
     'no-ambiguous-paths': 'error',
-    'no-path-trailing-slash': 'error',
-    'path-segment-plural': 'error',
-    'path-declaration-must-exist': 'error',
-    'path-not-include-query': 'error',
-    'path-parameters-defined': 'error',
-    'operation-description': 'error',
-    'operation-2xx-response': 'error',
-    'operation-4xx-response': 'error',
-    'operation-operationId': 'error',
+    'no-invalid-schema-examples': 'error',
+    'no-invalid-parameter-examples': 'error',
+    'no-http-verbs-in-paths': 'error',
+    'no-enum-type-mismatch': 'error',
+    'no-unresolved-refs': 'error',
+    'no-required-schema-properties-undefined': 'error',
     'operation-summary': 'error',
+    'operation-operationId': 'error',
     'operation-operationId-unique': 'error',
     'operation-operationId-url-safe': 'error',
+    'operation-description': 'error',
+    'operation-2xx-response': 'error',
+    'operation-4xx-response': 'error',
     'operation-parameters-unique': 'error',
     'operation-tag-defined': 'error',
-    'security-defined': 'error',
     'operation-singular-tag': 'error',
-    'no-unresolved-refs': 'error',
-    'no-enum-type-mismatch': 'error',
+    'parameter-description': 'error',
+    'path-declaration-must-exist': 'error',
+    'path-not-include-query': 'error',
+    'path-parameters-defined': 'error',
     'paths-kebab-case': 'error',
-    'no-http-verbs-in-paths': 'error',
     'path-excludes-patterns': {
       severity: 'error',
       patterns: [],
     },
-    spec: 'error',
-    'no-invalid-schema-examples': 'error',
-    'no-invalid-parameter-examples': 'error',
-    'scalar-property-missing-example': 'error',
-    'spec-strict-refs': 'error',
     'path-http-verbs-order': 'error',
     'path-params-defined': 'error',
+    'path-segment-plural': 'error',
     'required-string-property-missing-min-length': 'error',
     'response-contains-header': 'error',
-    'no-required-schema-properties-undefined': 'error',
-  },
-  oas2Rules: {
-    'boolean-parameter-prefixes': 'error',
     'request-mime-type': {
       severity: 'error',
       allowedValues: ['application/json'],
@@ -57,8 +52,29 @@ const all: PluginStyleguideConfig<'built-in'> = {
       allowedValues: ['application/json'],
     },
     'response-contains-property': 'error',
+    'security-defined': 'error',
+    'spec-strict-refs': 'error',
+    'scalar-property-missing-example': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'error',
   },
   oas3_0Rules: {
+    'array-parameter-serialization': 'error',
+    'boolean-parameter-prefixes': 'error',
+    'component-name-unique': 'error',
+    'info-contact': 'error',
+    'info-license': 'error',
+    'info-license-url': 'error',
+    'info-license-strict': 'error',
+    'no-path-trailing-slash': 'error',
+    'no-identical-paths': 'error',
+    'no-ambiguous-paths': 'error',
+    'no-invalid-schema-examples': 'error',
+    'no-invalid-parameter-examples': 'error',
+    'no-http-verbs-in-paths': 'error',
+    'no-enum-type-mismatch': 'error',
+    'no-unresolved-refs': 'error',
+    'no-required-schema-properties-undefined': 'error',
     'no-invalid-media-type-examples': 'error',
     'no-server-example.com': 'error',
     'no-server-trailing-slash': 'error',
@@ -67,8 +83,31 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
     'no-server-variables-empty-enum': 'error',
+    'operation-summary': 'error',
+    'operation-operationId': 'error',
+    'operation-operationId-unique': 'error',
+    'operation-operationId-url-safe': 'error',
+    'operation-description': 'error',
+    'operation-2xx-response': 'error',
+    'operation-4xx-response': 'error',
     'operation-4xx-problem-details-rfc7807': 'error',
-    'boolean-parameter-prefixes': 'error',
+    'operation-parameters-unique': 'error',
+    'operation-tag-defined': 'error',
+    'operation-singular-tag': 'error',
+    'parameter-description': 'error',
+    'path-declaration-must-exist': 'error',
+    'path-not-include-query': 'error',
+    'path-parameters-defined': 'error',
+    'paths-kebab-case': 'error',
+    'path-excludes-patterns': {
+      severity: 'error',
+      patterns: [],
+    },
+    'path-http-verbs-order': 'error',
+    'path-params-defined': 'error',
+    'path-segment-plural': 'error',
+    'required-string-property-missing-min-length': 'error',
+    'response-contains-header': 'error',
     'request-mime-type': {
       severity: 'error',
       allowedValues: ['application/json'],
@@ -77,12 +116,31 @@ const all: PluginStyleguideConfig<'built-in'> = {
       severity: 'error',
       allowedValues: ['application/json'],
     },
-    'component-name-unique': 'error',
     'response-contains-property': 'error',
+    'security-defined': 'error',
+    'spec-strict-refs': 'error',
+    'scalar-property-missing-example': 'error',
     'spec-components-invalid-map-name': 'error',
-    'array-parameter-serialization': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'error',
   },
   oas3_1Rules: {
+    'array-parameter-serialization': 'error',
+    'boolean-parameter-prefixes': 'error',
+    'component-name-unique': 'error',
+    'info-contact': 'error',
+    'info-license': 'error',
+    'info-license-url': 'error',
+    'info-license-strict': 'error',
+    'no-path-trailing-slash': 'error',
+    'no-identical-paths': 'error',
+    'no-ambiguous-paths': 'error',
+    'no-invalid-schema-examples': 'error',
+    'no-invalid-parameter-examples': 'error',
+    'no-http-verbs-in-paths': 'error',
+    'no-enum-type-mismatch': 'error',
+    'no-unresolved-refs': 'error',
+    'no-required-schema-properties-undefined': 'error',
     'no-invalid-media-type-examples': 'error',
     'no-server-example.com': 'error',
     'no-server-trailing-slash': 'error',
@@ -91,8 +149,31 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
     'no-server-variables-empty-enum': 'error',
+    'parameter-description': 'error',
+    'path-declaration-must-exist': 'error',
+    'path-not-include-query': 'error',
+    'path-parameters-defined': 'error',
+    'paths-kebab-case': 'error',
+    'path-excludes-patterns': {
+      severity: 'error',
+      patterns: [],
+    },
+    'path-http-verbs-order': 'error',
+    'path-params-defined': 'error',
+    'path-segment-plural': 'error',
+    'operation-summary': 'error',
+    'operation-operationId': 'error',
+    'operation-operationId-unique': 'error',
+    'operation-operationId-url-safe': 'error',
+    'operation-description': 'error',
+    'operation-2xx-response': 'error',
+    'operation-4xx-response': 'error',
     'operation-4xx-problem-details-rfc7807': 'error',
-    'boolean-parameter-prefixes': 'error',
+    'operation-parameters-unique': 'error',
+    'operation-tag-defined': 'error',
+    'operation-singular-tag': 'error',
+    'required-string-property-missing-min-length': 'error',
+    'response-contains-header': 'error',
     'request-mime-type': {
       severity: 'error',
       allowedValues: ['application/json'],
@@ -101,47 +182,47 @@ const all: PluginStyleguideConfig<'built-in'> = {
       severity: 'error',
       allowedValues: ['application/json'],
     },
-    'component-name-unique': 'error',
     'response-contains-property': 'error',
+    'security-defined': 'error',
+    'spec-strict-refs': 'error',
+    'scalar-property-missing-example': 'error',
     'spec-components-invalid-map-name': 'error',
-    'array-parameter-serialization': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'error',
   },
   async2Rules: {
-    spec: 'error',
+    'channels-kebab-case': 'error',
     'info-contact': 'error',
     'info-license-strict': 'error',
+    'no-channel-trailing-slash': 'error',
     'operation-operationId': 'error',
     'tag-description': 'error',
     'tags-alphabetical': 'error',
-    'channels-kebab-case': 'error',
-    'no-channel-trailing-slash': 'error',
   },
   async3Rules: {
-    spec: 'error',
+    'channels-kebab-case': 'error',
     'info-contact': 'error',
     'info-license-strict': 'error',
+    'no-channel-trailing-slash': 'error',
     'operation-operationId': 'error',
     'tag-description': 'error',
     'tags-alphabetical': 'error',
-    'channels-kebab-case': 'error',
-    'no-channel-trailing-slash': 'error',
   },
-  arazzoRules: {
-    spec: 'error',
+  arazzo1Rules: {
+    'criteria-unique': 'error',
+    'no-criteria-xpath': 'error',
     'parameters-not-in-body': 'error',
+    'parameters-unique': 'error',
+    'requestBody-replacements-unique': 'error',
     'sourceDescription-type': 'error',
-    'version-enum': 'error',
-    'workflowId-unique': 'error',
+    'step-onSuccess-unique': 'error',
+    'step-onFailure-unique': 'error',
     'stepId-unique': 'error',
     'sourceDescription-name-unique': 'error',
+    'sourceDescriptions-not-empty': 'error',
+    'version-enum': 'error',
+    'workflowId-unique': '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',
   },
 };
 

package/src/config/builtIn.ts

@@ -2,51 +2,53 @@ import recommended from './recommended';
 import recommendedStrict from './recommended-strict';
 import all from './all';
 import minimal from './minimal';
+import spec from './spec';
 import { rules as oas3Rules, preprocessors as oas3Preprocessors } from '../rules/oas3';
 import { rules as oas2Rules, preprocessors as oas2Preprocessors } from '../rules/oas2';
 import { rules as async2Rules, preprocessors as async2Preprocessors } from '../rules/async2';
 import { rules as async3Rules, preprocessors as async3Preprocessors } from '../rules/async3';
-import { rules as arazzoRules, preprocessors as arazzoPreprocessors } from '../rules/arazzo';
+import { rules as arazzo1Rules, preprocessors as arazzoPreprocessors } from '../rules/arazzo';
 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 arazzoDecorators } from '../decorators/arazzo';
+import { decorators as arazzo1Decorators } from '../decorators/arazzo';
 
-import type { CustomRulesConfig, StyleguideRawConfig, Plugin } from './types';
+import type { StyleguideRawConfig, Plugin } from './types';
 
 export const builtInConfigs: Record<string, StyleguideRawConfig> = {
   recommended,
   'recommended-strict': recommendedStrict,
   minimal,
   all,
+  spec,
   'redocly-registry': {
     decorators: { 'registry-dependencies': 'on' },
   },
 };
 
-export const defaultPlugin: Plugin = {
+export const defaultPlugin: Plugin<'built-in'> = {
   id: '', // default plugin doesn't have id
   rules: {
     oas3: oas3Rules,
     oas2: oas2Rules,
     async2: async2Rules,
     async3: async3Rules,
-    arazzo: arazzoRules,
-  } as CustomRulesConfig,
+    arazzo1: arazzo1Rules,
+  },
   preprocessors: {
     oas3: oas3Preprocessors,
     oas2: oas2Preprocessors,
     async2: async2Preprocessors,
     async3: async3Preprocessors,
-    arazzo: arazzoPreprocessors,
+    arazzo1: arazzoPreprocessors,
   },
   decorators: {
     oas3: oas3Decorators,
     oas2: oas2Decorators,
     async2: async2Decorators,
     async3: async3Decorators,
-    arazzo: arazzoDecorators,
+    arazzo1: arazzo1Decorators,
   },
   configs: builtInConfigs,
 };

package/src/config/config-resolvers.ts

@@ -261,8 +261,8 @@ export async function resolvePlugins(
         if (pluginModule.rules.async3) {
           plugin.rules.async3 = prefixRules(pluginModule.rules.async3, id);
         }
-        if (pluginModule.rules.arazzo) {
-          plugin.rules.arazzo = prefixRules(pluginModule.rules.arazzo, id);
+        if (pluginModule.rules.arazzo1) {
+          plugin.rules.arazzo1 = prefixRules(pluginModule.rules.arazzo1, id);
         }
       }
       if (pluginModule.preprocessors) {
@@ -271,7 +271,7 @@ export async function resolvePlugins(
           !pluginModule.preprocessors.oas2 &&
           !pluginModule.preprocessors.async2 &&
           !pluginModule.preprocessors.async3 &&
-          !pluginModule.preprocessors.arazzo
+          !pluginModule.preprocessors.arazzo1
         ) {
           throw new Error(
             `Plugin \`preprocessors\` must have \`oas3\`, \`oas2\` or \`async2\` preprocessors "${p}.`
@@ -290,8 +290,8 @@ export async function resolvePlugins(
         if (pluginModule.preprocessors.async3) {
           plugin.preprocessors.async3 = prefixRules(pluginModule.preprocessors.async3, id);
         }
-        if (pluginModule.preprocessors.arazzo) {
-          plugin.preprocessors.arazzo = prefixRules(pluginModule.preprocessors.arazzo, id);
+        if (pluginModule.preprocessors.arazzo1) {
+          plugin.preprocessors.arazzo1 = prefixRules(pluginModule.preprocessors.arazzo1, id);
         }
       }
 
@@ -301,7 +301,7 @@ export async function resolvePlugins(
           !pluginModule.decorators.oas2 &&
           !pluginModule.decorators.async2 &&
           !pluginModule.decorators.async3 &&
-          !pluginModule.decorators.arazzo
+          !pluginModule.decorators.arazzo1
         ) {
           throw new Error(
             `Plugin \`decorators\` must have \`oas3\`, \`oas2\`, \`async2\` or \`async3\` decorators "${p}.`
@@ -320,8 +320,8 @@ export async function resolvePlugins(
         if (pluginModule.decorators.async3) {
           plugin.decorators.async3 = prefixRules(pluginModule.decorators.async3, id);
         }
-        if (pluginModule.decorators.arazzo) {
-          plugin.decorators.arazzo = prefixRules(pluginModule.decorators.arazzo, id);
+        if (pluginModule.decorators.arazzo1) {
+          plugin.decorators.arazzo1 = prefixRules(pluginModule.decorators.arazzo1, id);
         }
       }
 
@@ -370,19 +370,19 @@ export async function resolveApis({
   return resolvedApis;
 }
 
-async function resolveAndMergeNestedStyleguideConfig(
-  {
-    styleguideConfig,
-    configPath = '',
-    resolver = new BaseResolver(),
-  }: {
-    styleguideConfig?: StyleguideRawConfig;
-    configPath?: string;
-    resolver?: BaseResolver;
-  },
-  parentConfigPaths: string[] = [],
-  extendPaths: string[] = []
-): Promise<ResolvedStyleguideConfig> {
+async function resolveAndMergeNestedStyleguideConfig({
+  styleguideConfig,
+  configPath = '',
+  resolver = new BaseResolver(),
+  parentConfigPaths = [],
+  extendPaths = [],
+}: {
+  styleguideConfig?: StyleguideRawConfig;
+  configPath?: string;
+  resolver?: BaseResolver;
+  parentConfigPaths?: string[];
+  extendPaths?: string[];
+}): Promise<ResolvedStyleguideConfig> {
   if (parentConfigPaths.includes(configPath)) {
     throw new Error(`Circular dependency in config file: "${configPath}"`);
   }
@@ -414,15 +414,13 @@ async function resolveAndMergeNestedStyleguideConfig(
         ? new URL(presetItem, configPath).href
         : path.resolve(path.dirname(configPath), presetItem);
       const extendedStyleguideConfig = await loadExtendStyleguideConfig(pathItem, resolver);
-      return await resolveAndMergeNestedStyleguideConfig(
-        {
-          styleguideConfig: extendedStyleguideConfig,
-          configPath: pathItem,
-          resolver: resolver,
-        },
-        [...parentConfigPaths, resolvedConfigPath],
-        extendPaths
-      );
+      return await resolveAndMergeNestedStyleguideConfig({
+        styleguideConfig: extendedStyleguideConfig,
+        configPath: pathItem,
+        resolver,
+        parentConfigPaths: [...parentConfigPaths, resolvedConfigPath],
+        extendPaths,
+      });
     }) || []
   );
 
@@ -446,20 +444,14 @@ async function resolveAndMergeNestedStyleguideConfig(
   };
 }
 
-export async function resolveStyleguideConfig(
-  opts: {
-    styleguideConfig?: StyleguideRawConfig;
-    configPath?: string;
-    resolver?: BaseResolver;
-  },
-  parentConfigPaths: string[] = [],
-  extendPaths: string[] = []
-): Promise<ResolvedStyleguideConfig> {
-  const resolvedStyleguideConfig = await resolveAndMergeNestedStyleguideConfig(
-    opts,
-    parentConfigPaths,
-    extendPaths
-  );
+export async function resolveStyleguideConfig(opts: {
+  styleguideConfig?: StyleguideRawConfig;
+  configPath?: string;
+  resolver?: BaseResolver;
+  parentConfigPaths?: string[];
+  extendPaths?: string[];
+}): Promise<ResolvedStyleguideConfig> {
+  const resolvedStyleguideConfig = await resolveAndMergeNestedStyleguideConfig(opts);
 
   return {
     ...resolvedStyleguideConfig,
@@ -520,7 +512,7 @@ function getMergedRawStyleguideConfig(
     oas3_1Rules: { ...rootStyleguideConfig?.oas3_1Rules, ...apiStyleguideConfig?.oas3_1Rules },
     async2Rules: { ...rootStyleguideConfig?.async2Rules, ...apiStyleguideConfig?.async2Rules },
     async3Rules: { ...rootStyleguideConfig?.async3Rules, ...apiStyleguideConfig?.async3Rules },
-    arazzoRules: { ...rootStyleguideConfig?.arazzoRules, ...apiStyleguideConfig?.arazzoRules },
+    arazzo1Rules: { ...rootStyleguideConfig?.arazzo1Rules, ...apiStyleguideConfig?.arazzo1Rules },
     preprocessors: {
       ...rootStyleguideConfig?.preprocessors,
       ...apiStyleguideConfig?.preprocessors,