@redocly/openapi-core 1.17.0 → 1.18.0

package/src/__tests__/lint.test.ts

@@ -1593,4 +1593,128 @@ describe('lint', () => {
     expect(result[0]).toHaveProperty('ignored', true);
     expect(result[0]).toHaveProperty('ruleId', 'operation-operationId');
   });
+
+  it('should throw an error for dependentRequired not expected here - OAS 3.0.x', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.3
+        info:
+          title: test json schema validation keyword - dependentRequired
+          version: 1.0.0
+        paths:
+          '/thing':
+            get:
+              summary: a sample api
+              responses:
+                '200':
+                  description: OK
+                  content:
+                    'application/json':
+                      schema:
+                        $ref: '#/components/schemas/test_schema'
+                      examples:
+                        dependentRequired_passing:
+                          summary: an example schema
+                          value: { "name": "bobby", "age": 25}
+                        dependentRequired_failing:
+                          summary: an example schema
+                          value: { "name": "jennie"}
+        components:
+          schemas:
+            test_schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                age:
+                  type: number
+              dependentRequired:
+                name:
+                - age
+      `,
+      ''
+    );
+
+    const configFilePath = path.join(__dirname, '..', '..', '..', 'redocly.yaml');
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ spec: 'error' }, undefined, configFilePath),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "from": {
+            "pointer": "#/paths/~1thing/get/responses/200/content/application~1json/schema",
+            "source": "",
+          },
+          "location": [
+            {
+              "pointer": "#/components/schemas/test_schema/dependentRequired",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`dependentRequired\` is not expected here.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not throw an error for dependentRequired not expected here - OAS 3.1.x', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.1.0
+        info:
+          title: test json schema validation keyword - dependentRequired
+          version: 1.0.0
+        paths:
+          '/thing':
+            get:
+              summary: a sample api
+              responses:
+                '200':
+                  description: OK
+                  content:
+                    'application/json':
+                      schema:
+                        $ref: '#/components/schemas/test_schema'
+                      examples:
+                        dependentRequired_passing:
+                          summary: an example schema
+                          value: { "name": "bobby", "age": 25}
+                        dependentRequired_failing:
+                          summary: an example schema
+                          value: { "name": "jennie"}
+        components:
+          schemas:
+            test_schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                age:
+                  type: number
+              dependentRequired:
+                name:
+                - age
+      `,
+      ''
+    );
+
+    const configFilePath = path.join(__dirname, '..', '..', '..', 'redocly.yaml');
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ spec: 'error' }, undefined, configFilePath),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
 });

package/src/bundle.ts

@@ -293,6 +293,15 @@ export function mapTypeToComponent(typeName: string, version: SpecMajorVersion)
         default:
           return null;
       }
+    case SpecMajorVersion.Arazzo:
+      switch (typeName) {
+        case 'Root.x-parameters_items':
+        case 'Root.workflows_items.parameters_items':
+        case 'Root.workflows_items.steps_items.parameters_items':
+          return 'parameters';
+        default:
+          return null;
+      }
   }
 }
 
@@ -367,6 +376,10 @@ function makeBundleVisitor(
           components = root.components = root.components || {};
         } else if (version === SpecMajorVersion.OAS2) {
           components = root;
+        } else if (version === SpecMajorVersion.Async2) {
+          components = root.components = root.components || {};
+        } else if (version === SpecMajorVersion.Arazzo) {
+          components = root.components = root.components || {};
         }
       },
     },

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

@@ -2,11 +2,21 @@
 
 exports[`resolveConfig should ignore minimal from the root and read local file 1`] = `
 {
+  "arazzoDecorators": {},
+  "arazzoPreprocessors": {},
+  "arazzoRules": {
+    "spec": "error",
+  },
   "async2Decorators": {},
   "async2Preprocessors": {},
   "async2Rules": {
     "channels-kebab-case": "off",
+    "info-contact": "off",
     "no-channel-trailing-slash": "off",
+    "operation-operationId": "warn",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
   },
   "decorators": {},
   "doNotResolveExamples": undefined,
@@ -109,11 +119,21 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
 
 exports[`resolveStyleguideConfig should resolve extends with local file config which contains path to nested config 1`] = `
 {
+  "arazzoDecorators": {},
+  "arazzoPreprocessors": {},
+  "arazzoRules": {
+    "spec": "error",
+  },
   "async2Decorators": {},
   "async2Preprocessors": {},
   "async2Rules": {
     "channels-kebab-case": "off",
+    "info-contact": "off",
     "no-channel-trailing-slash": "off",
+    "operation-operationId": "warn",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
   },
   "decorators": {},
   "doNotResolveExamples": undefined,

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

@@ -6,6 +6,7 @@ StyleguideConfig {
   "_usedVersions": Set {},
   "configFile": undefined,
   "decorators": {
+    "arazzo": {},
     "async2": {
       "oas2": {},
       "oas3_0": {},
@@ -44,6 +45,7 @@ StyleguideConfig {
   "pluginPaths": [],
   "plugins": [],
   "preprocessors": {
+    "arazzo": {},
     "async2": {
       "oas2": {},
       "oas3_0": {},
@@ -107,6 +109,7 @@ StyleguideConfig {
   },
   "recommendedFallback": false,
   "rules": {
+    "arazzo": {},
     "async2": {
       "oas2": {
         "no-empty-servers": "error",

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

@@ -117,6 +117,7 @@ describe('getMergedConfig', () => {
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
           "decorators": {
+            "arazzo": {},
             "async2": {},
             "oas2": {},
             "oas3_0": {},
@@ -128,6 +129,7 @@ describe('getMergedConfig', () => {
           "pluginPaths": [],
           "plugins": [],
           "preprocessors": {
+            "arazzo": {},
             "async2": {},
             "oas2": {},
             "oas3_0": {},
@@ -142,6 +144,7 @@ describe('getMergedConfig', () => {
           },
           "recommendedFallback": false,
           "rules": {
+            "arazzo": {},
             "async2": {
               "operation-summary": "warn",
             },
@@ -222,6 +225,7 @@ describe('getMergedConfig', () => {
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
           "decorators": {
+            "arazzo": {},
             "async2": {},
             "oas2": {},
             "oas3_0": {},
@@ -233,6 +237,7 @@ describe('getMergedConfig', () => {
           "pluginPaths": [],
           "plugins": [],
           "preprocessors": {
+            "arazzo": {},
             "async2": {},
             "oas2": {},
             "oas3_0": {},
@@ -249,6 +254,7 @@ describe('getMergedConfig', () => {
           },
           "recommendedFallback": false,
           "rules": {
+            "arazzo": {},
             "async2": {
               "no-empty-servers": "error",
               "operation-summary": "error",

package/src/config/all.ts

@@ -106,9 +106,15 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'array-parameter-serialization': 'error',
   },
   async2Rules: {
+    spec: 'error',
+    'info-contact': 'error',
+    'operation-operationId': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'error',
     'channels-kebab-case': 'error',
     'no-channel-trailing-slash': 'error',
   },
+  arazzoRules: { spec: 'error' },
 };
 
 export default all;

package/src/config/builtIn.ts

@@ -5,10 +5,15 @@ import minimal from './minimal';
 import { rules as oas3Rules } from '../rules/oas3';
 import { rules as oas2Rules } from '../rules/oas2';
 import { rules as async2Rules } from '../rules/async2';
+import { rules as arazzoRules } from '../rules/arazzo';
 import { preprocessors as oas3Preprocessors } from '../rules/oas3';
 import { preprocessors as oas2Preprocessors } from '../rules/oas2';
+import { preprocessors as async2Preprocessors } from '../rules/async2';
+import { 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 arazzoDecorators } from '../decorators/arazzo';
 
 import type { CustomRulesConfig, StyleguideRawConfig, Plugin } from './types';
 
@@ -28,16 +33,19 @@ export const defaultPlugin: Plugin = {
     oas3: oas3Rules,
     oas2: oas2Rules,
     async2: async2Rules,
+    arazzo: arazzoRules,
   } as CustomRulesConfig,
   preprocessors: {
     oas3: oas3Preprocessors,
     oas2: oas2Preprocessors,
-    async2: {},
+    async2: async2Preprocessors,
+    arazzo: arazzoPreprocessors,
   },
   decorators: {
     oas3: oas3Decorators,
     oas2: oas2Decorators,
-    async2: {},
+    async2: async2Decorators,
+    arazzo: arazzoDecorators,
   },
   configs: builtInConfigs,
 };

package/src/config/config-resolvers.ts

@@ -180,7 +180,9 @@ export function resolvePlugins(
 
       if (pluginModule.rules) {
         if (!pluginModule.rules.oas3 && !pluginModule.rules.oas2 && !pluginModule.rules.async2) {
-          throw new Error(`Plugin rules must have \`oas3\`, \`oas2\` or \`async2\` rules "${p}.`);
+          throw new Error(
+            `Plugin rules must have \`oas3\`, \`oas2\`, \`async2\`, or \`arazzo\` rules "${p}.`
+          );
         }
         plugin.rules = {};
         if (pluginModule.rules.oas3) {
@@ -192,12 +194,16 @@ export function resolvePlugins(
         if (pluginModule.rules.async2) {
           plugin.rules.async2 = prefixRules(pluginModule.rules.async2, id);
         }
+        if (pluginModule.rules.arazzo) {
+          plugin.rules.arazzo = prefixRules(pluginModule.rules.arazzo, id);
+        }
       }
       if (pluginModule.preprocessors) {
         if (
           !pluginModule.preprocessors.oas3 &&
           !pluginModule.preprocessors.oas2 &&
-          !pluginModule.preprocessors.async2
+          !pluginModule.preprocessors.async2 &&
+          !pluginModule.preprocessors.arazzo
         ) {
           throw new Error(
             `Plugin \`preprocessors\` must have \`oas3\`, \`oas2\` or \`async2\` preprocessors "${p}.`
@@ -213,13 +219,17 @@ export function resolvePlugins(
         if (pluginModule.preprocessors.async2) {
           plugin.preprocessors.async2 = prefixRules(pluginModule.preprocessors.async2, id);
         }
+        if (pluginModule.preprocessors.arazzo) {
+          plugin.preprocessors.arazzo = prefixRules(pluginModule.preprocessors.arazzo, id);
+        }
       }
 
       if (pluginModule.decorators) {
         if (
           !pluginModule.decorators.oas3 &&
           !pluginModule.decorators.oas2 &&
-          !pluginModule.decorators.async2
+          !pluginModule.decorators.async2 &&
+          !pluginModule.decorators.arazzo
         ) {
           throw new Error(
             `Plugin \`decorators\` must have \`oas3\`, \`oas2\` or \`async2\` decorators "${p}.`
@@ -235,6 +245,9 @@ export function resolvePlugins(
         if (pluginModule.decorators.async2) {
           plugin.decorators.async2 = prefixRules(pluginModule.decorators.async2, id);
         }
+        if (pluginModule.decorators.arazzo) {
+          plugin.decorators.arazzo = prefixRules(pluginModule.decorators.arazzo, id);
+        }
       }
 
       if (pluginModule.assertions) {
@@ -419,6 +432,7 @@ function getMergedRawStyleguideConfig(
     oas2Rules: { ...rootStyleguideConfig?.oas2Rules, ...apiStyleguideConfig?.oas2Rules },
     oas3_0Rules: { ...rootStyleguideConfig?.oas3_0Rules, ...apiStyleguideConfig?.oas3_0Rules },
     oas3_1Rules: { ...rootStyleguideConfig?.oas3_1Rules, ...apiStyleguideConfig?.oas3_1Rules },
+    arazzoRules: { ...rootStyleguideConfig?.arazzoRules, ...apiStyleguideConfig?.arazzoRules },
     preprocessors: {
       ...rootStyleguideConfig?.preprocessors,
       ...apiStyleguideConfig?.preprocessors,

package/src/config/config.ts

@@ -9,6 +9,7 @@ import {
   Oas2RuleSet,
   Oas3RuleSet,
   Async2RuleSet,
+  ArazzoRuleSet,
 } from '../oas-types';
 import { isBrowser } from '../env';
 
@@ -71,6 +72,7 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_0]: { ...rawConfig.rules, ...rawConfig.oas3_0Rules },
       [SpecVersion.OAS3_1]: { ...rawConfig.rules, ...rawConfig.oas3_1Rules },
       [SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
+      [SpecVersion.Arazzo]: { ...rawConfig.arazzoRules },
     };
 
     this.preprocessors = {
@@ -78,6 +80,7 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_0]: { ...rawConfig.preprocessors, ...rawConfig.oas3_0Preprocessors },
       [SpecVersion.OAS3_1]: { ...rawConfig.preprocessors, ...rawConfig.oas3_1Preprocessors },
       [SpecVersion.Async2]: { ...rawConfig.preprocessors, ...rawConfig.async2Preprocessors },
+      [SpecVersion.Arazzo]: { ...rawConfig.arazzoPreprocessors },
     };
 
     this.decorators = {
@@ -85,6 +88,7 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_0]: { ...rawConfig.decorators, ...rawConfig.oas3_0Decorators },
       [SpecVersion.OAS3_1]: { ...rawConfig.decorators, ...rawConfig.oas3_1Decorators },
       [SpecVersion.Async2]: { ...rawConfig.decorators, ...rawConfig.async2Decorators },
+      [SpecVersion.Arazzo]: { ...rawConfig.arazzoDecorators },
     };
 
     this.extendPaths = rawConfig.extendPaths || [];
@@ -178,6 +182,10 @@ export class StyleguideConfig {
             if (!plugin.typeExtension.async2) continue;
             extendedTypes = plugin.typeExtension.async2(extendedTypes, version);
             break;
+          case SpecVersion.Arazzo:
+            if (!plugin.typeExtension.arazzo) continue;
+            extendedTypes = plugin.typeExtension.arazzo(extendedTypes, version);
+            break;
           default:
             throw new Error('Not implemented');
         }
@@ -277,6 +285,15 @@ export class StyleguideConfig {
           (p) => p.decorators?.async2 && asyncApiRules.push(p.decorators.async2)
         );
         return asyncApiRules;
+      case SpecMajorVersion.Arazzo:
+        // eslint-disable-next-line no-case-declarations
+        const arazzoRules: ArazzoRuleSet[] = []; // default ruleset
+        this.plugins.forEach(
+          (p) => p.preprocessors?.arazzo && arazzoRules.push(p.preprocessors.arazzo)
+        );
+        this.plugins.forEach((p) => p.rules?.arazzo && arazzoRules.push(p.rules.arazzo));
+        this.plugins.forEach((p) => p.decorators?.arazzo && arazzoRules.push(p.decorators.arazzo));
+        return arazzoRules;
     }
   }
 

package/src/config/minimal.ts

@@ -88,9 +88,17 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'array-parameter-serialization': 'off',
   },
   async2Rules: {
+    spec: 'error',
+    'info-contact': 'off',
+    'operation-operationId': 'warn',
+    'tag-description': 'warn',
+    'tags-alphabetical': 'off',
     'channels-kebab-case': 'off',
     'no-channel-trailing-slash': 'off',
   },
+  arazzoRules: {
+    spec: 'error',
+  },
 };
 
 export default minimal;

package/src/config/recommended-strict.ts

@@ -88,9 +88,17 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'array-parameter-serialization': 'off',
   },
   async2Rules: {
+    spec: 'error',
+    'info-contact': 'off',
+    'operation-operationId': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'off',
     'channels-kebab-case': 'off',
     'no-channel-trailing-slash': 'off',
   },
+  arazzoRules: {
+    spec: 'error',
+  },
 };
 
 export default recommendedStrict;

package/src/config/recommended.ts

@@ -88,9 +88,17 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'array-parameter-serialization': 'off',
   },
   async2Rules: {
+    spec: 'error',
+    'info-contact': 'off',
+    'operation-operationId': 'warn',
+    'tag-description': 'warn',
+    'tags-alphabetical': 'off',
     'channels-kebab-case': 'off',
     'no-channel-trailing-slash': 'off',
   },
+  arazzoRules: {
+    spec: 'error',
+  },
 };
 
 export default recommended;

package/src/config/types.ts

@@ -11,6 +11,9 @@ import type {
   Async2PreprocessorsSet,
   Async2DecoratorsSet,
   Async2RuleSet,
+  ArazzoRuleSet,
+  ArazzoPreprocessorsSet,
+  ArazzoDecoratorsSet,
   RuleMap,
 } from '../oas-types';
 
@@ -20,9 +23,9 @@ import type { SkipFunctionContext } from '../visitors';
 import {
   BuiltInAsync2RuleId,
   BuiltInCommonOASRuleId,
-  BuiltInCommonRuleId,
   BuiltInOAS2RuleId,
   BuiltInOAS3RuleId,
+  BuiltInArazzoRuleId,
 } from '../types/redocly-yaml';
 
 export type RuleSeverity = ProblemSeverity | 'off';
@@ -51,23 +54,26 @@ export type StyleguideRawConfig<T = undefined> = {
   doNotResolveExamples?: boolean;
   recommendedFallback?: boolean;
 
-  rules?: RuleMap<BuiltInCommonRuleId | BuiltInCommonOASRuleId, RuleConfig, T>;
+  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>;
+  arazzoRules?: RuleMap<BuiltInArazzoRuleId, RuleConfig, T>;
 
   preprocessors?: Record<string, PreprocessorConfig>;
   oas2Preprocessors?: Record<string, PreprocessorConfig>;
   oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
   oas3_1Preprocessors?: Record<string, PreprocessorConfig>;
   async2Preprocessors?: Record<string, PreprocessorConfig>;
+  arazzoPreprocessors?: 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>;
+  arazzoDecorators?: Record<string, DecoratorConfig>;
 };
 
 export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
@@ -84,12 +90,14 @@ export type PreprocessorsConfig = {
   oas3?: Oas3PreprocessorsSet;
   oas2?: Oas2PreprocessorsSet;
   async2?: Async2PreprocessorsSet;
+  arazzo?: ArazzoPreprocessorsSet;
 };
 
 export type DecoratorsConfig = {
   oas3?: Oas3DecoratorsSet;
   oas2?: Oas2DecoratorsSet;
   async2?: Async2DecoratorsSet;
+  arazzo?: ArazzoDecoratorsSet;
 };
 
 export type TypesExtensionFn = (
@@ -103,6 +111,7 @@ export type CustomRulesConfig = {
   oas3?: Oas3RuleSet;
   oas2?: Oas2RuleSet;
   async2?: Async2RuleSet;
+  arazzo?: ArazzoRuleSet;
 };
 
 export type AssertionContext = Partial<UserContext> & SkipFunctionContext & { node: any };
@@ -227,19 +236,23 @@ export type ThemeRawConfig = {
   mockServer?: Record<string, any>;
 };
 
+// TODO: sync types
 export type RulesFields =
   | 'rules'
   | 'oas2Rules'
   | 'oas3_0Rules'
   | 'oas3_1Rules'
   | 'async2Rules'
+  | 'arazzoRules'
   | 'preprocessors'
   | 'oas2Preprocessors'
   | 'oas3_0Preprocessors'
   | 'oas3_1Preprocessors'
   | 'async2Preprocessors'
+  | 'arazzoPreprocessors'
   | 'decorators'
   | 'oas2Decorators'
   | 'oas3_0Decorators'
   | 'oas3_1Decorators'
+  | 'arazzoDecorators'
   | 'async2Decorators';