@redocly/openapi-core 1.0.0-beta.104 → 1.0.0-beta.107

package/lib/config/types.d.ts

@@ -10,7 +10,7 @@ export declare type PreprocessorConfig = PreprocessorSeverity | ({
     severity?: ProblemSeverity;
 } & Record<string, any>);
 export declare type DecoratorConfig = PreprocessorConfig;
-export declare type LintRawConfig = {
+export declare type StyleguideRawConfig = {
     plugins?: (string | Plugin)[];
     extends?: string[];
     doNotResolveExamples?: boolean;
@@ -28,7 +28,8 @@ export declare type LintRawConfig = {
     oas3_0Decorators?: Record<string, DecoratorConfig>;
     oas3_1Decorators?: Record<string, DecoratorConfig>;
 };
-export declare type ResolvedLintConfig = PluginLintConfig & {
+export declare type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
+export declare type ResolvedStyleguideConfig = PluginStyleguideConfig & {
     plugins?: Plugin[];
     recommendedFallback?: boolean;
     extends?: void | never;
@@ -51,13 +52,13 @@ export declare type CustomRulesConfig = {
 };
 export declare type Plugin = {
     id: string;
-    configs?: Record<string, PluginLintConfig>;
+    configs?: Record<string, PluginStyleguideConfig>;
     rules?: CustomRulesConfig;
     preprocessors?: PreprocessorsConfig;
     decorators?: DecoratorsConfig;
     typeExtension?: TypeExtensionsConfig;
 };
-export declare type PluginLintConfig = Omit<LintRawConfig, 'plugins' | 'extends'>;
+export declare type PluginStyleguideConfig = Omit<StyleguideRawConfig, 'plugins' | 'extends'>;
 export declare type ResolveHeader = {
     name: string;
     envVariable?: undefined;
@@ -83,33 +84,36 @@ export declare type Region = 'us' | 'eu';
 export declare type AccessTokens = {
     [region in Region]?: string;
 };
-export declare type DeprecatedRawConfig = {
+export declare type DeprecatedInRawConfig = {
     apiDefinitions?: Record<string, string>;
-    lint?: LintRawConfig;
-    resolve?: RawResolveConfig;
-    region?: Region;
+    lint?: StyleguideRawConfig;
     referenceDocs?: Record<string, any>;
+    apis?: Record<string, Api & DeprecatedInApi>;
 };
 export declare type Api = {
     root: string;
-    lint?: Omit<LintRawConfig, 'plugins'>;
-    'features.openapi'?: Record<string, any>;
-    'features.mockServer'?: Record<string, any>;
+    styleguide?: ApiStyleguideRawConfig;
+} & FeaturesConfig;
+export declare type DeprecatedInApi = {
+    lint?: ApiStyleguideRawConfig;
 };
-export declare type ResolvedApi = Omit<Api, 'lint'> & {
-    lint: Omit<ResolvedLintConfig, 'plugins'>;
+export declare type ResolvedApi = Omit<Api, 'styleguide'> & {
+    styleguide: ResolvedStyleguideConfig;
 };
 export declare type RawConfig = {
     apis?: Record<string, Api>;
-    lint?: LintRawConfig;
+    styleguide?: StyleguideRawConfig;
     resolve?: RawResolveConfig;
     region?: Region;
-    'features.openapi'?: Record<string, any>;
-    'features.mockServer'?: Record<string, any>;
     organization?: string;
-};
-export declare type ResolvedConfig = Omit<RawConfig, 'lint' | 'apis'> & {
-    lint: ResolvedLintConfig;
+} & FeaturesConfig;
+export declare type ResolvedConfig = Omit<RawConfig, 'apis' | 'styleguide'> & {
     apis: Record<string, ResolvedApi>;
+    styleguide: ResolvedStyleguideConfig;
+};
+declare type FeaturesConfig = {
+    'features.openapi'?: Record<string, any>;
+    'features.mockServer'?: Record<string, any>;
 };
 export declare type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators';
+export {};

package/lib/config/utils.d.ts

@@ -1,13 +1,13 @@
 import { Config } from './config';
-import type { Api, DeprecatedRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedLintConfig, RulesFields } from './types';
+import type { Api, DeprecatedInRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedStyleguideConfig, RulesFields } from './types';
 export declare function parsePresetName(presetName: string): {
     pluginId: string;
     configName: string;
 };
-export declare function transformApiDefinitionsToApis(apiDefinitions?: Record<string, string>): Record<string, Api>;
+export declare function transformApiDefinitionsToApis(apiDefinitions?: DeprecatedInRawConfig['apiDefinitions']): Record<string, Api> | undefined;
 export declare function prefixRules<T extends Record<string, any>>(rules: T, prefix: string): any;
-export declare function mergeExtends(rulesConfList: ResolvedLintConfig[]): Omit<ResolvedLintConfig, RulesFields> & Required<Pick<ResolvedLintConfig, RulesFields>>;
-export declare function getMergedConfig(config: Config, entrypointAlias?: string): Config;
-export declare function transformConfig(rawConfig: DeprecatedRawConfig | RawConfig): RawConfig;
+export declare function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]): Omit<ResolvedStyleguideConfig, RulesFields> & Required<Pick<ResolvedStyleguideConfig, RulesFields>>;
+export declare function getMergedConfig(config: Config, apiName?: string): Config;
+export declare function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig): RawConfig;
 export declare function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig;
 export declare function getUniquePlugins(plugins: Plugin[]): Plugin[];

package/lib/config/utils.js

@@ -25,14 +25,26 @@ function parsePresetName(presetName) {
     }
 }
 exports.parsePresetName = parsePresetName;
-function transformApiDefinitionsToApis(apiDefinitions = {}) {
-    let apis = {};
+function transformApiDefinitionsToApis(apiDefinitions) {
+    if (!apiDefinitions)
+        return undefined;
+    const apis = {};
     for (const [apiName, apiPath] of Object.entries(apiDefinitions)) {
         apis[apiName] = { root: apiPath };
     }
     return apis;
 }
 exports.transformApiDefinitionsToApis = transformApiDefinitionsToApis;
+function transformApis(legacyApis) {
+    if (!legacyApis)
+        return undefined;
+    const apis = {};
+    for (let _a of Object.entries(legacyApis)) {
+        const [apiName, _b] = _a, { lint } = _b, apiContent = __rest(_b, ["lint"]);
+        apis[apiName] = Object.assign({ styleguide: lint }, apiContent);
+    }
+    return apis;
+}
 function prefixRules(rules, prefix) {
     if (!prefix)
         return rules;
@@ -63,7 +75,7 @@ function mergeExtends(rulesConfList) {
     };
     for (let rulesConf of rulesConfList) {
         if (rulesConf.extends) {
-            throw new Error(`\`extends\` is not supported in shared configs yet: ${JSON.stringify(rulesConf, null, 2)}.`);
+            throw new Error(`'extends' is not supported in shared configs yet: ${JSON.stringify(rulesConf, null, 2)}.`);
         }
         Object.assign(result.rules, rulesConf.rules);
         Object.assign(result.oas2Rules, rulesConf.oas2Rules);
@@ -93,44 +105,49 @@ function mergeExtends(rulesConfList) {
     return result;
 }
 exports.mergeExtends = mergeExtends;
-function getMergedConfig(config, entrypointAlias) {
+function getMergedConfig(config, apiName) {
     var _a, _b, _c, _d, _e, _f;
     const extendPaths = [
-        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.lint) === null || _a === void 0 ? void 0 : _a.extendPaths; }),
-        (_b = (_a = config.rawConfig) === null || _a === void 0 ? void 0 : _a.lint) === null || _b === void 0 ? void 0 : _b.extendPaths,
+        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.styleguide) === null || _a === void 0 ? void 0 : _a.extendPaths; }),
+        (_b = (_a = config.rawConfig) === null || _a === void 0 ? void 0 : _a.styleguide) === null || _b === void 0 ? void 0 : _b.extendPaths,
     ]
         .flat()
         .filter(Boolean);
     const pluginPaths = [
-        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.lint) === null || _a === void 0 ? void 0 : _a.pluginPaths; }),
-        (_d = (_c = config.rawConfig) === null || _c === void 0 ? void 0 : _c.lint) === null || _d === void 0 ? void 0 : _d.pluginPaths,
+        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.styleguide) === null || _a === void 0 ? void 0 : _a.pluginPaths; }),
+        (_d = (_c = config.rawConfig) === null || _c === void 0 ? void 0 : _c.styleguide) === null || _d === void 0 ? void 0 : _d.pluginPaths,
     ]
         .flat()
         .filter(Boolean);
-    return entrypointAlias
-        ? new config_1.Config(Object.assign(Object.assign({}, config.rawConfig), { lint: Object.assign(Object.assign({}, (config.apis[entrypointAlias]
-                ? config.apis[entrypointAlias].lint
-                : config.rawConfig.lint)), { extendPaths,
-                pluginPaths }), 'features.openapi': Object.assign(Object.assign({}, config['features.openapi']), (_e = config.apis[entrypointAlias]) === null || _e === void 0 ? void 0 : _e['features.openapi']), 'features.mockServer': Object.assign(Object.assign({}, config['features.mockServer']), (_f = config.apis[entrypointAlias]) === null || _f === void 0 ? void 0 : _f['features.mockServer']) }), config.configFile)
+    return apiName
+        ? new config_1.Config(Object.assign(Object.assign({}, config.rawConfig), { styleguide: Object.assign(Object.assign({}, (config.apis[apiName]
+                ? config.apis[apiName].styleguide
+                : config.rawConfig.styleguide)), { extendPaths,
+                pluginPaths }), 'features.openapi': Object.assign(Object.assign({}, config['features.openapi']), (_e = config.apis[apiName]) === null || _e === void 0 ? void 0 : _e['features.openapi']), 'features.mockServer': Object.assign(Object.assign({}, config['features.mockServer']), (_f = config.apis[apiName]) === null || _f === void 0 ? void 0 : _f['features.mockServer']) }), config.configFile)
         : config;
 }
 exports.getMergedConfig = getMergedConfig;
-function transformConfig(rawConfig) {
-    if (rawConfig.apis && rawConfig.apiDefinitions) {
-        throw new Error("Do not use 'apiDefinitions' field. Use 'apis' instead.\n");
+function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig) {
+    const isDeprecatedFieldInApis = rawConfig.apis &&
+        Object.values(rawConfig.apis).some((api) => api[deprecatedField]);
+    if (rawConfig[deprecatedField] && rawConfig[updatedField]) {
+        utils_1.showErrorForDeprecatedField(deprecatedField, updatedField);
     }
-    if (rawConfig['features.openapi'] &&
-        rawConfig.referenceDocs) {
-        throw new Error("Do not use 'referenceDocs' field. Use 'features.openapi' instead.\n");
+    if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
+        utils_1.showWarningForDeprecatedField(deprecatedField, updatedField);
     }
-    const _a = rawConfig, { apiDefinitions, referenceDocs } = _a, rest = __rest(_a, ["apiDefinitions", "referenceDocs"]);
-    if (apiDefinitions) {
-        process.stderr.write(`The ${colorette_1.yellow('apiDefinitions')} field is deprecated. Use ${colorette_1.green('apis')} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
-    }
-    if (referenceDocs) {
-        process.stderr.write(`The ${colorette_1.yellow('referenceDocs')} field is deprecated. Use ${colorette_1.green('features.openapi')} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
+}
+function transformConfig(rawConfig) {
+    const migratedFields = [
+        ['apiDefinitions', 'apis'],
+        ['referenceDocs', 'features.openapi'],
+        ['lint', 'styleguide'], // TODO: update docs
+    ];
+    for (const [deprecatedField, updatedField] of migratedFields) {
+        checkForDeprecatedFields(deprecatedField, updatedField, rawConfig);
     }
-    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApiDefinitionsToApis(apiDefinitions) }, rest);
+    const { apis, apiDefinitions, referenceDocs, lint } = rawConfig, rest = __rest(rawConfig, ["apis", "apiDefinitions", "referenceDocs", "lint"]);
+    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: lint }, rest);
 }
 exports.transformConfig = transformConfig;
 function getResolveConfig(resolve) {

package/lib/decorators/common/remove-x-internal.js

@@ -51,8 +51,8 @@ const RemoveXInternal = ({ internalFlagProperty }) => {
         any: {
             enter: (node, ctx) => {
                 removeInternal(node, ctx);
-            }
-        }
+            },
+        },
     };
 };
 exports.RemoveXInternal = RemoveXInternal;

package/lib/format/format.js

@@ -167,7 +167,7 @@ function formatProblems(problems, opts) {
     function formatStylish(problem, locationPad, ruleIdPad) {
         const color = COLORS[problem.severity];
         if (!SEVERITY_NAMES[problem.severity]) {
-            return 'Error not found severity. Please check your config file. Allowed values: \`warn,error,off\`';
+            return 'Error not found severity. Please check your config file. Allowed values: `warn,error,off`';
         }
         const severityName = color(SEVERITY_NAMES[problem.severity].toLowerCase().padEnd(7));
         const { start } = problem.location[0];

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-export { BundleOutputFormat, readFileFromUrl, slash } from './utils';
+export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
@@ -8,7 +8,7 @@ export { Oas2Definition } from './typings/swagger';
 export { StatsAccumulator, StatsName } from './typings/common';
 export { normalizeTypes } from './types';
 export { Stats } from './rules/other/stats';
-export { Config, LintConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity } from './config';
+export { Config, StyleguideConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, } from './config';
 export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
 export { parseYaml, stringifyYaml } from './js-yaml';

package/lib/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.LintConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.slash = exports.readFileFromUrl = void 0;
+exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
+Object.defineProperty(exports, "doesYamlFileExist", { enumerable: true, get: function () { return utils_1.doesYamlFileExist; } });
 var oas3_1_1 = require("./types/oas3_1");
 Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
 var oas3_1 = require("./types/oas3");
@@ -18,7 +19,7 @@ var stats_1 = require("./rules/other/stats");
 Object.defineProperty(exports, "Stats", { enumerable: true, get: function () { return stats_1.Stats; } });
 var config_1 = require("./config");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
-Object.defineProperty(exports, "LintConfig", { enumerable: true, get: function () { return config_1.LintConfig; } });
+Object.defineProperty(exports, "StyleguideConfig", { enumerable: true, get: function () { return config_1.StyleguideConfig; } });
 Object.defineProperty(exports, "IGNORE_FILE", { enumerable: true, get: function () { return config_1.IGNORE_FILE; } });
 Object.defineProperty(exports, "getMergedConfig", { enumerable: true, get: function () { return config_1.getMergedConfig; } });
 Object.defineProperty(exports, "transformConfig", { enumerable: true, get: function () { return config_1.transformConfig; } });

package/lib/js-yaml/index.js

@@ -6,12 +6,7 @@ exports.stringifyYaml = exports.parseYaml = void 0;
 const js_yaml_1 = require("js-yaml");
 const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = js_yaml_1.JSON_SCHEMA.extend({
     implicit: [js_yaml_1.types.merge],
-    explicit: [
-        js_yaml_1.types.binary,
-        js_yaml_1.types.omap,
-        js_yaml_1.types.pairs,
-        js_yaml_1.types.set,
-    ],
+    explicit: [js_yaml_1.types.binary, js_yaml_1.types.omap, js_yaml_1.types.pairs, js_yaml_1.types.set],
 });
 const parseYaml = (str, opts) => js_yaml_1.load(str, Object.assign({ schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP }, opts));
 exports.parseYaml = parseYaml;

package/lib/lint.d.ts

@@ -1,7 +1,7 @@
 import { BaseResolver, Document } from './resolve';
 import { NodeType } from './types';
 import { ProblemSeverity } from './walk';
-import { LintConfig, Config } from './config';
+import { StyleguideConfig, Config } from './config';
 export declare function lint(opts: {
     ref: string;
     config: Config;
@@ -15,7 +15,7 @@ export declare function lintFromString(opts: {
 }): Promise<import("./walk").NormalizedProblem[]>;
 export declare function lintDocument(opts: {
     document: Document;
-    config: LintConfig;
+    config: StyleguideConfig;
     customTypes?: Record<string, NodeType>;
     externalRefResolver: BaseResolver;
 }): Promise<import("./walk").NormalizedProblem[]>;

package/lib/lint.js

@@ -26,7 +26,7 @@ function lint(opts) {
     return __awaiter(this, void 0, void 0, function* () {
         const { ref, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
         const document = (yield externalRefResolver.resolveDocument(null, ref, true));
-        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.lint }));
+        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.styleguide }));
     });
 }
 exports.lint = lint;
@@ -34,7 +34,7 @@ function lintFromString(opts) {
     return __awaiter(this, void 0, void 0, function* () {
         const { source, absoluteRef, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
         const document = resolve_1.makeDocumentFromString(source, absoluteRef || '/');
-        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.lint }));
+        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.styleguide }));
     });
 }
 exports.lintFromString = lintFromString;
@@ -45,7 +45,11 @@ function lintDocument(opts) {
         const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
         const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
         const rules = config.getRulesForOasVersion(oasMajorVersion);
-        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3) ? (oasVersion === oas_types_1.OasVersion.Version3_1 ? oas3_1_1.Oas3_1Types : oas3_1.Oas3Types) : oas2_1.Oas2Types, oasVersion), config);
+        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3)
+            ? oasVersion === oas_types_1.OasVersion.Version3_1
+                ? oas3_1_1.Oas3_1Types
+                : oas3_1.Oas3Types
+            : oas2_1.Oas2Types, oasVersion), config);
         const ctx = {
             problems: [],
             oasVersion: oasVersion,
@@ -57,7 +61,7 @@ function lintDocument(opts) {
         const resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
             rootType: types.DefinitionRoot,
-            externalRefResolver
+            externalRefResolver,
         });
         walk_1.walkDocument({
             document,
@@ -79,12 +83,18 @@ function lintConfig(opts) {
             visitorsData: {},
         };
         const plugins = config_1.resolvePlugins([config_1.defaultPlugin]);
-        const config = new config_1.LintConfig({
+        const config = new config_1.StyleguideConfig({
             plugins,
             rules: { spec: 'error' },
         });
         const types = types_1.normalizeTypes(redocly_yaml_1.ConfigTypes, config);
-        const rules = [{ severity: severity || 'error', ruleId: 'configuration spec', visitor: spec_1.OasSpec({ severity: 'error' }) }];
+        const rules = [
+            {
+                severity: severity || 'error',
+                ruleId: 'configuration spec',
+                visitor: spec_1.OasSpec({ severity: 'error' }),
+            },
+        ];
         const normalizedVisitors = visitors_1.normalizeVisitors(rules, types);
         walk_1.walkDocument({
             document,

package/lib/redocly/registry-api.d.ts

@@ -13,5 +13,5 @@ export declare class RegistryApi {
         organizations: string[];
     }>;
     prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }: RegistryApiTypes.PrepareFileuploadParams): Promise<RegistryApiTypes.PrepareFileuploadOKResponse>;
-    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize }: RegistryApiTypes.PushApiParams): Promise<void>;
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize, }: RegistryApiTypes.PushApiParams): Promise<void>;
 }

package/lib/redocly/registry-api.js

@@ -80,7 +80,7 @@ class RegistryApi {
             throw new Error('Could not prepare file upload');
         });
     }
-    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize }) {
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.request(`/${organizationId}/${name}/${version}`, {
                 method: 'PUT',
@@ -95,7 +95,7 @@ class RegistryApi {
                     isUpsert,
                     isPublic,
                     batchId,
-                    batchSize
+                    batchSize,
                 }),
             }, this.region);
             if (response.ok) {

package/lib/rules/ajv.d.ts

@@ -2,7 +2,7 @@ import { ErrorObject } from '@redocly/ajv';
 import { Location } from '../ref-utils';
 import { ResolveFn } from '../walk';
 export declare function releaseAjvInstance(): void;
-export declare function validateJsonSchema(data: any, schema: any, schemaLoc: Location, instancePath: string, resolve: ResolveFn, disallowAdditionalProperties: boolean): {
+export declare function validateJsonSchema(data: any, schema: any, schemaLoc: Location, instancePath: string, resolve: ResolveFn, allowAdditionalProperties: boolean): {
     valid: boolean;
     errors: (ErrorObject & {
         suggest?: string[];

package/lib/rules/ajv.js

@@ -8,7 +8,7 @@ function releaseAjvInstance() {
     ajvInstance = null;
 }
 exports.releaseAjvInstance = releaseAjvInstance;
-function getAjv(resolve, disallowAdditionalProperties) {
+function getAjv(resolve, allowAdditionalProperties) {
     if (!ajvInstance) {
         ajvInstance = new ajv_1.default({
             schemaId: '$id',
@@ -20,7 +20,7 @@ function getAjv(resolve, disallowAdditionalProperties) {
             discriminator: true,
             allowUnionTypes: true,
             validateFormats: false,
-            defaultAdditionalProperties: !disallowAdditionalProperties,
+            defaultAdditionalProperties: allowAdditionalProperties,
             loadSchemaSync(base, $ref) {
                 const resolvedRef = resolve({ $ref }, base.split('#')[0]);
                 if (!resolvedRef || !resolvedRef.location)
@@ -32,15 +32,15 @@ function getAjv(resolve, disallowAdditionalProperties) {
     }
     return ajvInstance;
 }
-function getAjvValidator(schema, loc, resolve, disallowAdditionalProperties) {
-    const ajv = getAjv(resolve, disallowAdditionalProperties);
+function getAjvValidator(schema, loc, resolve, allowAdditionalProperties) {
+    const ajv = getAjv(resolve, allowAdditionalProperties);
     if (!ajv.getSchema(loc.absolutePointer)) {
         ajv.addSchema(Object.assign({ $id: loc.absolutePointer }, schema), loc.absolutePointer);
     }
     return ajv.getSchema(loc.absolutePointer);
 }
-function validateJsonSchema(data, schema, schemaLoc, instancePath, resolve, disallowAdditionalProperties) {
-    const validate = getAjvValidator(schema, schemaLoc, resolve, disallowAdditionalProperties);
+function validateJsonSchema(data, schema, schemaLoc, instancePath, resolve, allowAdditionalProperties) {
+    const validate = getAjvValidator(schema, schemaLoc, resolve, allowAdditionalProperties);
     if (!validate)
         return { valid: true, errors: [] }; // unresolved refs are reported
     const valid = validate(data, {

package/lib/rules/common/info-license-url.d.ts

@@ -1,2 +1,2 @@
 import { Oas3Rule, Oas2Rule } from '../../visitors';
-export declare const InfoLicense: Oas3Rule | Oas2Rule;
+export declare const InfoLicenseUrl: Oas3Rule | Oas2Rule;

package/lib/rules/common/info-license-url.js

@@ -1,17 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InfoLicense = void 0;
+exports.InfoLicenseUrl = void 0;
 const utils_1 = require("../utils");
-const InfoLicense = () => {
+const InfoLicenseUrl = () => {
     return {
-        Info(info, { report }) {
-            if (!info.license) {
-                report({
-                    message: utils_1.missingRequiredField('Info', 'license'),
-                    location: { reportOnKey: true }
-                });
-            }
+        License(license, ctx) {
+            utils_1.validateDefinedAndNonEmpty('url', license, ctx);
         },
     };
 };
-exports.InfoLicense = InfoLicense;
+exports.InfoLicenseUrl = InfoLicenseUrl;

package/lib/rules/common/info-license.d.ts

@@ -0,0 +1,2 @@
+import { Oas3Rule, Oas2Rule } from '../../visitors';
+export declare const InfoLicense: Oas3Rule | Oas2Rule;

package/lib/rules/common/info-license.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoLicense = void 0;
+const utils_1 = require("../utils");
+const InfoLicense = () => {
+    return {
+        Info(info, { report }) {
+            if (!info.license) {
+                report({
+                    message: utils_1.missingRequiredField('Info', 'license'),
+                    location: { reportOnKey: true },
+                });
+            }
+        },
+    };
+};
+exports.InfoLicense = InfoLicense;

package/lib/rules/common/no-enum-type-mismatch.js

@@ -28,14 +28,12 @@ const NoEnumTypeMismatch = () => {
                     if (mismatchedResults[enumValue].length !== schema.type.length)
                         delete mismatchedResults[enumValue];
                 }
-                ;
                 for (const mismatchedKey of Object.keys(mismatchedResults)) {
                     report({
-                        message: `Enum value \`${mismatchedKey}\` must be of one type. Allowed types: \`${schema.type}\`.`,
+                        message: `Enum value \`${mismatchedKey}\` must be of allowed types: \`${schema.type}\`.`,
                         location: location.child(['enum', schema.enum.indexOf(mismatchedKey)]),
                     });
                 }
-                ;
             }
         },
     };

package/lib/rules/common/no-invalid-parameter-examples.js

@@ -4,17 +4,17 @@ exports.NoInvalidParameterExamples = void 0;
 const utils_1 = require("../utils");
 const NoInvalidParameterExamples = (opts) => {
     var _a;
-    const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
+    const allowAdditionalProperties = (_a = utils_1.getAdditionalPropertiesOption(opts)) !== null && _a !== void 0 ? _a : false;
     return {
         Parameter: {
             leave(parameter, ctx) {
                 if (parameter.example) {
-                    utils_1.validateExample(parameter.example, parameter.schema, ctx.location.child('example'), ctx, disallowAdditionalProperties);
+                    utils_1.validateExample(parameter.example, parameter.schema, ctx.location.child('example'), ctx, allowAdditionalProperties);
                 }
                 if (parameter.examples) {
                     for (const [key, example] of Object.entries(parameter.examples)) {
                         if ('value' in example) {
-                            utils_1.validateExample(example.value, parameter.schema, ctx.location.child(['examples', key]), ctx, false);
+                            utils_1.validateExample(example.value, parameter.schema, ctx.location.child(['examples', key]), ctx, true);
                         }
                     }
                 }

package/lib/rules/common/no-invalid-schema-examples.js

@@ -4,17 +4,17 @@ exports.NoInvalidSchemaExamples = void 0;
 const utils_1 = require("../utils");
 const NoInvalidSchemaExamples = (opts) => {
     var _a;
-    const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
+    const allowAdditionalProperties = (_a = utils_1.getAdditionalPropertiesOption(opts)) !== null && _a !== void 0 ? _a : false;
     return {
         Schema: {
             leave(schema, ctx) {
                 if (schema.examples) {
                     for (const example of schema.examples) {
-                        utils_1.validateExample(example, schema, ctx.location.child(['examples', schema.examples.indexOf(example)]), ctx, disallowAdditionalProperties);
+                        utils_1.validateExample(example, schema, ctx.location.child(['examples', schema.examples.indexOf(example)]), ctx, allowAdditionalProperties);
                     }
                 }
                 if (schema.example) {
-                    utils_1.validateExample(schema.example, schema, ctx.location.child('example'), ctx, false);
+                    utils_1.validateExample(schema.example, schema, ctx.location.child('example'), ctx, true);
                 }
             },
         },

package/lib/rules/common/operation-operationId.js

@@ -10,7 +10,7 @@ const OperationOperationId = () => {
                     utils_1.validateDefinedAndNonEmpty('operationId', operation, ctx);
                 },
             },
-        }
+        },
     };
 };
 exports.OperationOperationId = OperationOperationId;

package/lib/rules/common/path-not-include-query.js

@@ -12,7 +12,7 @@ const PathNotIncludeQuery = () => {
                     });
                 }
             },
-        }
+        },
     };
 };
 exports.PathNotIncludeQuery = PathNotIncludeQuery;

package/lib/rules/common/paths-kebab-case.js

@@ -4,7 +4,10 @@ exports.PathsKebabCase = void 0;
 const PathsKebabCase = () => {
     return {
         PathItem(_path, { report, key }) {
-            const segments = key.substr(1).split('/').filter(s => s !== ''); // filter out empty segments
+            const segments = key
+                .substr(1)
+                .split('/')
+                .filter((s) => s !== ''); // filter out empty segments
             if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
                 report({
                     message: `\`${key}\` does not use kebab-case.`,

package/lib/rules/common/spec.js

@@ -45,7 +45,7 @@ const OasSpec = () => {
                     }
                     report({
                         message: `The field \`${propName}\` is not allowed here.`,
-                        location: location.child([propName]).key()
+                        location: location.child([propName]).key(),
                     });
                 }
             }