@redocly/openapi-core 1.0.0-beta.108 → 1.0.0-beta.109

package/lib/benchmark/benches/resolve-with-no-external.bench.js

@@ -16,7 +16,7 @@ function measureAsync() {
     return resolve_1.resolveDocument({
         rootDocument: rebillyDocument,
         externalRefResolver,
-        rootType: types_1.normalizeTypes(oas3_1.Oas3Types).DefinitionRoot,
+        rootType: types_1.normalizeTypes(oas3_1.Oas3Types).Root,
     });
 }
 exports.measureAsync = measureAsync;

package/lib/bundle.d.ts

@@ -44,4 +44,4 @@ export declare function bundleDocument(opts: {
     refTypes: Map<string, NormalizedNodeType> | undefined;
     visitorsData: Record<string, Record<string, unknown>>;
 }>;
-export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "responses" | "schemas" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;
+export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "responses" | "schemas" | "requestBodies" | "links" | "callbacks" | "securitySchemes" | null;

package/lib/bundle.js

@@ -76,7 +76,7 @@ function bundleDocument(opts) {
         }
         const resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             externalRefResolver,
         });
         const bundleVisitor = visitors_1.normalizeVisitors([
@@ -90,7 +90,7 @@ function bundleDocument(opts) {
         ], types);
         walk_1.walkDocument({
             document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             normalizedVisitors: bundleVisitor,
             resolvedRefMap,
             ctx,
@@ -99,7 +99,7 @@ function bundleDocument(opts) {
             bundle: document,
             problems: ctx.problems.map((problem) => config.addProblemToIgnore(problem)),
             fileDependencies: externalRefResolver.getFiles(),
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             refTypes: ctx.refTypes,
             visitorsData: ctx.visitorsData,
         };
@@ -184,7 +184,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 }
             },
         },
-        DefinitionRoot: {
+        Root: {
             enter(root) {
                 if (version === oas_types_1.OasMajorVersion.Version3) {
                     components = root.components = root.components || {};

package/lib/config/all.js

@@ -26,7 +26,7 @@ exports.default = {
         'operation-operationId-url-safe': 'error',
         'operation-parameters-unique': 'error',
         'operation-tag-defined': 'error',
-        'operation-security-defined': 'error',
+        'security-defined': 'error',
         'operation-singular-tag': 'error',
         'no-unresolved-refs': 'error',
         'no-enum-type-mismatch': 'error',
@@ -52,6 +52,7 @@ exports.default = {
         'no-unused-components': 'error',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'operation-4xx-problem-details-rfc7807': 'error',
     },
     oas3_1Rules: {
         'no-server-example.com': 'error',
@@ -61,5 +62,6 @@ exports.default = {
         'no-unused-components': 'error',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'operation-4xx-problem-details-rfc7807': 'error',
     },
 };

package/lib/config/config-resolvers.js

@@ -135,7 +135,7 @@ function resolvePlugins(plugins, configPath = '') {
         }
         return plugin;
     })
-        .filter(utils_2.notUndefined);
+        .filter(utils_2.isDefined);
 }
 exports.resolvePlugins = resolvePlugins;
 function resolveApis({ rawConfig, configPath = '', resolver, }) {

package/lib/config/minimal.js

@@ -24,7 +24,7 @@ exports.default = {
         'operation-operationId-unique': 'warn',
         'operation-parameters-unique': 'warn',
         'operation-tag-defined': 'off',
-        'operation-security-defined': 'warn',
+        'security-defined': 'warn',
         'operation-operationId-url-safe': 'warn',
         'operation-singular-tag': 'off',
         'no-unresolved-refs': 'error',
@@ -45,6 +45,7 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'warn',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'warn',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'warn',
@@ -55,5 +56,6 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'warn',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'warn',
     },
 };

package/lib/config/recommended.js

@@ -25,7 +25,7 @@ exports.default = {
         'operation-operationId-url-safe': 'error',
         'operation-parameters-unique': 'error',
         'operation-tag-defined': 'off',
-        'operation-security-defined': 'error',
+        'security-defined': 'error',
         'operation-singular-tag': 'off',
         'no-unresolved-refs': 'error',
         'no-enum-type-mismatch': 'error',
@@ -45,6 +45,7 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'error',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'warn',
@@ -55,5 +56,6 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'error',
     },
 };

package/lib/config/rules.js

@@ -29,6 +29,6 @@ function initRules(rules, config, type, oasVersion) {
         };
     }))
         .flatMap((visitor) => visitor)
-        .filter(utils_1.notUndefined);
+        .filter(utils_1.isDefined);
 }
 exports.initRules = initRules;

package/lib/config/types.d.ts

@@ -72,6 +72,7 @@ export declare type ResolveHeader = {
 };
 export declare type RawResolveConfig = {
     http?: Partial<HttpResolveConfig>;
+    doNotResolveExamples?: boolean;
 };
 export declare type HttpResolveConfig = {
     headers: ResolveHeader[];
@@ -87,6 +88,7 @@ export declare type AccessTokens = {
 export declare type DeprecatedInRawConfig = {
     apiDefinitions?: Record<string, string>;
     lint?: StyleguideRawConfig;
+    styleguide?: StyleguideRawConfig;
     referenceDocs?: Record<string, any>;
     apis?: Record<string, Api & DeprecatedInApi>;
 };
@@ -107,6 +109,11 @@ export declare type RawConfig = {
     region?: Region;
     organization?: string;
 } & FeaturesConfig;
+export declare type FlatApi = Omit<Api, 'styleguide'> & Omit<ApiStyleguideRawConfig, 'doNotResolveExamples'>;
+export declare type FlatRawConfig = Omit<RawConfig, 'styleguide' | 'resolve' | 'apis'> & Omit<StyleguideRawConfig, 'doNotResolveExamples'> & {
+    resolve?: RawResolveConfig;
+    apis?: Record<string, FlatApi>;
+};
 export declare type ResolvedConfig = Omit<RawConfig, 'apis' | 'styleguide'> & {
     apis: Record<string, ResolvedApi>;
     styleguide: ResolvedStyleguideConfig;

package/lib/config/utils.d.ts

@@ -1,5 +1,5 @@
 import { Config } from './config';
-import type { Api, DeprecatedInRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedStyleguideConfig, RulesFields } from './types';
+import type { Api, DeprecatedInRawConfig, FlatRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedStyleguideConfig, RulesFields } from './types';
 export declare function parsePresetName(presetName: string): {
     pluginId: string;
     configName: string;
@@ -8,6 +8,6 @@ export declare function transformApiDefinitionsToApis(apiDefinitions?: Deprecate
 export declare function prefixRules<T extends Record<string, any>>(rules: T, prefix: string): any;
 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 transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig): RawConfig;
 export declare function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig;
 export declare function getUniquePlugins(plugins: Plugin[]): Plugin[];

package/lib/config/utils.js

@@ -35,13 +35,46 @@ function transformApiDefinitionsToApis(apiDefinitions) {
     return apis;
 }
 exports.transformApiDefinitionsToApis = transformApiDefinitionsToApis;
+function extractFlatConfig(_a) {
+    var _b;
+    var { plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators } = _a, rawConfigRest = __rest(_a, ["plugins", "extends", "rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators"]);
+    const styleguideConfig = {
+        plugins,
+        extends: _extends,
+        rules,
+        oas2Rules,
+        oas3_0Rules,
+        oas3_1Rules,
+        preprocessors,
+        oas2Preprocessors,
+        oas3_0Preprocessors,
+        oas3_1Preprocessors,
+        decorators,
+        oas2Decorators,
+        oas3_0Decorators,
+        oas3_1Decorators,
+        doNotResolveExamples: (_b = rawConfigRest.resolve) === null || _b === void 0 ? void 0 : _b.doNotResolveExamples,
+    };
+    if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
+        (Object.values(styleguideConfig).some(utils_1.isDefined) &&
+            (rawConfigRest.lint || rawConfigRest.styleguide))) {
+        throw new Error(`Do not use 'lint', 'styleguide' and flat syntax together. \nSee more about the configuration in the docs: https://redocly.com/docs/cli/configuration/ \n`);
+    }
+    return {
+        styleguideConfig: Object.values(styleguideConfig).some(utils_1.isDefined)
+            ? styleguideConfig
+            : undefined,
+        rawConfigRest,
+    };
+}
 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);
+        const { styleguideConfig, rawConfigRest } = extractFlatConfig(apiContent);
+        apis[apiName] = Object.assign({ styleguide: styleguideConfig || lint }, rawConfigRest);
     }
     return apis;
 }
@@ -130,7 +163,10 @@ exports.getMergedConfig = getMergedConfig;
 function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig) {
     const isDeprecatedFieldInApis = rawConfig.apis &&
         Object.values(rawConfig.apis).some((api) => api[deprecatedField]);
-    if (rawConfig[deprecatedField] && rawConfig[updatedField]) {
+    if (rawConfig[deprecatedField] && updatedField === null) {
+        utils_1.showWarningForDeprecatedField(deprecatedField);
+    }
+    if (rawConfig[deprecatedField] && updatedField && rawConfig[updatedField]) {
         utils_1.showErrorForDeprecatedField(deprecatedField, updatedField);
     }
     if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
@@ -141,13 +177,15 @@ function transformConfig(rawConfig) {
     const migratedFields = [
         ['apiDefinitions', 'apis'],
         ['referenceDocs', 'features.openapi'],
-        ['lint', 'styleguide'], // TODO: update docs
+        ['lint', undefined],
+        ['styleguide', undefined],
     ];
     for (const [deprecatedField, updatedField] of migratedFields) {
         checkForDeprecatedFields(deprecatedField, updatedField, rawConfig);
     }
     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);
+    const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
+    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: styleguideConfig || lint }, rawConfigRest);
 }
 exports.transformConfig = transformConfig;
 function getResolveConfig(resolve) {

package/lib/decorators/common/registry-dependencies.js

@@ -5,7 +5,7 @@ const redocly_1 = require("../../redocly");
 const RegistryDependencies = () => {
     const registryDependencies = new Set();
     return {
-        DefinitionRoot: {
+        Root: {
             leave(_, ctx) {
                 const data = ctx.getVisitorData();
                 data.links = Array.from(registryDependencies);

package/lib/format/format.d.ts

@@ -4,7 +4,7 @@ export declare type Totals = {
     warnings: number;
     ignored: number;
 };
-export declare type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate';
+export declare type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate' | 'summary';
 export declare function getTotals(problems: (NormalizedProblem & {
     ignored?: boolean;
 })[]): Totals;

package/lib/format/format.js

@@ -99,6 +99,9 @@ function formatProblems(problems, opts) {
         case 'codeclimate':
             outputForCodeClimate();
             break;
+        case 'summary':
+            formatSummary(problems);
+            break;
     }
     if (totalProblems - ignoredProblems > maxProblems) {
         logger_1.logger.info(`< ... ${totalProblems - maxProblems} more problems hidden > ${logger_1.colorize.gray('increase with `--max-problems N`')}\n`);
@@ -183,13 +186,31 @@ function formatProblems(problems, opts) {
     }
 }
 exports.formatProblems = formatProblems;
+function formatSummary(problems) {
+    const counts = {};
+    for (const problem of problems) {
+        counts[problem.ruleId] = counts[problem.ruleId] || { count: 0, severity: problem.severity };
+        counts[problem.ruleId].count++;
+    }
+    const sorted = Object.entries(counts).sort(([, a], [, b]) => {
+        const severityDiff = severityToNumber(a.severity) - severityToNumber(b.severity);
+        return severityDiff || b.count - a.count;
+    });
+    for (const [ruleId, info] of sorted) {
+        const color = COLORS[info.severity];
+        const severityName = color(SEVERITY_NAMES[info.severity].toLowerCase().padEnd(7));
+        logger_1.logger.info(`${severityName} ${ruleId}: ${info.count}\n`);
+    }
+    logger_1.logger.info('\n');
+}
 function formatFrom(cwd, location) {
     if (!location)
         return '';
     const relativePath = path.relative(cwd, location.source.absoluteRef);
     const loc = codeframes_1.getLineColLocation(location);
     const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;
-    return `referenced from ${logger_1.colorize.blue(fileWithLoc)}\n\n`;
+    const atPointer = location.pointer ? logger_1.colorize.gray(`at ${location.pointer}`) : '';
+    return `referenced from ${logger_1.colorize.blue(fileWithLoc)} ${atPointer} \n\n`;
 }
 function formatDidYouMean(problem) {
     if (problem.suggest.length === 0)

package/lib/lint.js

@@ -60,12 +60,12 @@ function lintDocument(opts) {
         const normalizedVisitors = visitors_1.normalizeVisitors([...preprocessors, ...regularRules], types);
         const resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             externalRefResolver,
         });
         walk_1.walkDocument({
             document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             normalizedVisitors,
             resolvedRefMap,
             ctx,

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

@@ -1,6 +1,5 @@
 import type { PrepareFileuploadOKResponse, PrepareFileuploadParams, PushApiParams } from './registry-api-types';
 import type { AccessTokens, Region } from '../config/types';
-export declare const currentCommand: string;
 export declare class RegistryApi {
     private accessTokens;
     private region;

package/lib/redocly/registry-api.js

@@ -8,14 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegistryApi = exports.currentCommand = void 0;
+exports.RegistryApi = void 0;
 const node_fetch_1 = require("node-fetch");
 const config_1 = require("../config/config");
 const utils_1 = require("../utils");
 const version = require('../../package.json').version;
-exports.currentCommand = typeof process !== 'undefined' ? ((_a = process.env) === null || _a === void 0 ? void 0 : _a.REDOCLY_CLI_COMMAND) || '' : '';
 class RegistryApi {
     constructor(accessTokens, region) {
         this.accessTokens = accessTokens;
@@ -32,10 +30,13 @@ class RegistryApi {
         return this;
     }
     request(path = '', options = {}, region) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            const currentCommand = typeof process !== 'undefined' ? ((_a = process.env) === null || _a === void 0 ? void 0 : _a.REDOCLY_CLI_COMMAND) || '' : '';
+            const redoclyEnv = typeof process !== 'undefined' ? ((_b = process.env) === null || _b === void 0 ? void 0 : _b.REDOCLY_ENVIRONMENT) || '' : '';
             const headers = Object.assign({}, options.headers || {}, {
                 'x-redocly-cli-version': version,
-                'user-agent': `redocly-cli / ${version} ${exports.currentCommand}`,
+                'user-agent': `redocly-cli / ${version} ${currentCommand} ${redoclyEnv}`,
             });
             if (!headers.hasOwnProperty('authorization')) {
                 throw new Error('Unauthorized');

package/lib/resolve.js

@@ -110,7 +110,9 @@ class BaseResolver {
                     return new Source(absoluteRef, body, mimeType);
                 }
                 else {
-                    return new Source(absoluteRef, yield fs.promises.readFile(absoluteRef, 'utf-8'));
+                    const content = yield fs.promises.readFile(absoluteRef, 'utf-8');
+                    // In some cases file have \r\n line delimeters like on windows, we should skip it.
+                    return new Source(absoluteRef, content.replace(/\r\n/g, '\n'));
                 }
             }
             catch (error) {

package/lib/rules/common/no-ambiguous-paths.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoAmbiguousPaths = void 0;
 const NoAmbiguousPaths = () => {
     return {
-        PathMap(pathMap, { report, location }) {
+        PathsMap(pathMap, { report, location }) {
             const seenPaths = [];
             for (const currentPath of Object.keys(pathMap)) {
                 const ambiguousPath = seenPaths.find((seenPath) => arePathsAmbiguous(seenPath, currentPath));

package/lib/rules/common/no-identical-paths.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoIdenticalPaths = void 0;
 const NoIdenticalPaths = () => {
     return {
-        PathMap(pathMap, { report, location }) {
+        PathsMap(pathMap, { report, location }) {
             const pathsMap = new Map();
             for (const pathName of Object.keys(pathMap)) {
                 const id = pathName.replace(/{.+?}/g, '{VARIABLE}');

package/lib/rules/common/operation-2xx-response.js

@@ -7,7 +7,7 @@ const Operation2xxResponse = () => {
             const codes = Object.keys(responses);
             if (!codes.some((code) => code === 'default' || /2[Xx0-9]{2}/.test(code))) {
                 report({
-                    message: 'Operation must have at least one `2xx` response.',
+                    message: 'Operation must have at least one `2XX` response.',
                     location: { reportOnKey: true },
                 });
             }

package/lib/rules/common/operation-4xx-response.js

@@ -7,7 +7,7 @@ const Operation4xxResponse = () => {
             const codes = Object.keys(responses);
             if (!codes.some((code) => /4[Xx0-9]{2}/.test(code))) {
                 report({
-                    message: 'Operation must have at least one `4xx` response.',
+                    message: 'Operation must have at least one `4XX` response.',
                     location: { reportOnKey: true },
                 });
             }

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

@@ -4,7 +4,7 @@ exports.OperationOperationId = void 0;
 const utils_1 = require("../utils");
 const OperationOperationId = () => {
     return {
-        DefinitionRoot: {
+        Root: {
             PathItem: {
                 Operation(operation, ctx) {
                     utils_1.validateDefinedAndNonEmpty('operationId', operation, ctx);

package/lib/rules/common/operation-tag-defined.js

@@ -4,7 +4,7 @@ exports.OperationTagDefined = void 0;
 const OperationTagDefined = () => {
     let definedTags;
     return {
-        DefinitionRoot(root) {
+        Root(root) {
             var _a;
             definedTags = new Set(((_a = root.tags) !== null && _a !== void 0 ? _a : []).map((t) => t.name));
         },

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PathNotIncludeQuery = void 0;
 const PathNotIncludeQuery = () => {
     return {
-        PathMap: {
+        PathsMap: {
             PathItem(_operation, { report, key }) {
                 if (key.toString().includes('?')) {
                     report({

package/lib/rules/common/security-defined.d.ts

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

package/lib/rules/common/{operation-security-defined.js → security-defined.js}

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OperationSecurityDefined = void 0;
-const OperationSecurityDefined = () => {
+exports.SecurityDefined = void 0;
+const SecurityDefined = () => {
     const referencedSchemes = new Map();
+    let eachOperationHasSecurity = true;
     return {
         DefinitionRoot: {
-            leave(_, { report }) {
+            leave(root, { report }) {
                 for (const [name, scheme] of referencedSchemes.entries()) {
                     if (scheme.defined)
                         continue;
@@ -16,6 +17,14 @@ const OperationSecurityDefined = () => {
                         });
                     }
                 }
+                if (root.security || eachOperationHasSecurity) {
+                    return;
+                }
+                else {
+                    report({
+                        message: `Every API should have security defined on the root level or for each operation.`,
+                    });
+                }
             },
         },
         SecurityScheme(_securityScheme, { key }) {
@@ -33,6 +42,11 @@ const OperationSecurityDefined = () => {
                 }
             }
         },
+        Operation(operation) {
+            if (!(operation === null || operation === void 0 ? void 0 : operation.security)) {
+                eachOperationHasSecurity = false;
+            }
+        },
     };
 };
-exports.OperationSecurityDefined = OperationSecurityDefined;
+exports.SecurityDefined = SecurityDefined;

package/lib/rules/common/spec.js

@@ -7,13 +7,15 @@ const ref_utils_1 = require("../../ref-utils");
 const utils_2 = require("../../utils");
 const OasSpec = () => {
     return {
-        any(node, { report, type, location, key, resolve, ignoreNextVisitorsOnNode }) {
+        any(node, { report, type, location, rawLocation, key, resolve, ignoreNextVisitorsOnNode }) {
             var _a, _b, _c, _d;
             const nodeType = utils_1.oasTypeOf(node);
+            const refLocation = rawLocation !== location ? rawLocation : undefined;
             if (type.items) {
                 if (nodeType !== 'array') {
                     report({
                         message: `Expected type \`${type.name}\` (array) but got \`${nodeType}\``,
+                        from: refLocation,
                     });
                     ignoreNextVisitorsOnNode();
                 }
@@ -22,6 +24,7 @@ const OasSpec = () => {
             else if (nodeType !== 'object') {
                 report({
                     message: `Expected type \`${type.name}\` (object) but got \`${nodeType}\``,
+                    from: refLocation,
                 });
                 ignoreNextVisitorsOnNode();
                 return;
@@ -31,6 +34,7 @@ const OasSpec = () => {
                 if (!node.hasOwnProperty(propName)) {
                     report({
                         message: `The field \`${propName}\` must be present on this level.`,
+                        from: refLocation,
                         location: [{ reportOnKey: true }],
                     });
                 }
@@ -45,6 +49,7 @@ const OasSpec = () => {
                     }
                     report({
                         message: `The field \`${propName}\` is not allowed here.`,
+                        from: refLocation,
                         location: location.child([propName]).key(),
                     });
                 }
@@ -60,6 +65,7 @@ const OasSpec = () => {
                 if (!hasProperty)
                     report({
                         message: `Must contain at least one of the following fields: ${(_b = type.requiredOneOf) === null || _b === void 0 ? void 0 : _b.join(', ')}.`,
+                        from: refLocation,
                         location: [{ reportOnKey: true }],
                     });
             }
@@ -82,6 +88,7 @@ const OasSpec = () => {
                     report({
                         message: `Property \`${propName}\` is not expected here.`,
                         suggest: utils_1.getSuggest(propName, Object.keys(type.properties)),
+                        from: refLocation,
                         location: propLocation.key(),
                     });
                     continue;
@@ -99,6 +106,7 @@ const OasSpec = () => {
                             message: `\`${propName}\` can be one of the following only: ${propSchema.enum
                                 .map((i) => `"${i}"`)
                                 .join(', ')}.`,
+                            from: refLocation,
                             suggest: utils_1.getSuggest(propValue, propSchema.enum),
                         });
                     }
@@ -106,6 +114,7 @@ const OasSpec = () => {
                 else if (propSchema.type && !utils_1.matchesJsonSchemaType(propValue, propSchema.type, false)) {
                     report({
                         message: `Expected type \`${propSchema.type}\` but got \`${propValueType}\`.`,
+                        from: refLocation,
                         location: propLocation,
                     });
                 }
@@ -116,6 +125,7 @@ const OasSpec = () => {
                         if (!utils_1.matchesJsonSchemaType(item, itemsType, false)) {
                             report({
                                 message: `Expected type \`${itemsType}\` but got \`${utils_1.oasTypeOf(item)}\`.`,
+                                from: refLocation,
                                 location: propLocation.child([i]),
                             });
                         }
@@ -125,6 +135,7 @@ const OasSpec = () => {
                     if (propSchema.minimum > node[propName]) {
                         report({
                             message: `The value of the ${propName} field must be greater than or equal to ${propSchema.minimum}`,
+                            from: refLocation,
                             location: location.child([propName]),
                         });
                     }

package/lib/rules/common/tags-alphabetical.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TagsAlphabetical = void 0;
 const TagsAlphabetical = () => {
     return {
-        DefinitionRoot(root, { report, location }) {
+        Root(root, { report, location }) {
             if (!root.tags)
                 return;
             for (let i = 0; i < root.tags.length - 1; i++) {

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

@@ -29,7 +29,7 @@ export declare const rules: {
     'path-params-defined': Oas2Rule;
     'parameter-description': Oas2Rule;
     'operation-singular-tag': Oas2Rule;
-    'operation-security-defined': Oas2Rule;
+    'security-defined': Oas2Rule;
     'no-unresolved-refs': Oas2Rule;
     'no-identical-paths': Oas2Rule;
     'no-ambiguous-paths': Oas2Rule;

package/lib/rules/oas2/index.js

@@ -27,7 +27,7 @@ const operation_description_1 = require("../common/operation-description");
 const path_not_include_query_1 = require("../common/path-not-include-query");
 const parameter_description_1 = require("../common/parameter-description");
 const operation_singular_tag_1 = require("../common/operation-singular-tag");
-const operation_security_defined_1 = require("../common/operation-security-defined");
+const security_defined_1 = require("../common/security-defined");
 const no_unresolved_refs_1 = require("../no-unresolved-refs");
 const path_http_verbs_order_1 = require("../common/path-http-verbs-order");
 const no_identical_paths_1 = require("../common/no-identical-paths");
@@ -72,7 +72,7 @@ exports.rules = {
     'path-params-defined': path_params_defined_1.PathParamsDefined,
     'parameter-description': parameter_description_1.ParameterDescription,
     'operation-singular-tag': operation_singular_tag_1.OperationSingularTag,
-    'operation-security-defined': operation_security_defined_1.OperationSecurityDefined,
+    'security-defined': security_defined_1.SecurityDefined,
     'no-unresolved-refs': no_unresolved_refs_1.NoUnresolvedRefs,
     'no-identical-paths': no_identical_paths_1.NoIdenticalPaths,
     'no-ambiguous-paths': no_ambiguous_paths_1.NoAmbiguousPaths,