@redocly/openapi-core 1.0.0-beta.98 → 1.0.0-rc.1

package/lib/rules/oas3/component-name-unique.d.ts

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

package/lib/rules/oas3/component-name-unique.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentNameUnique = void 0;
+const TYPE_NAME_SCHEMA = 'Schema';
+const TYPE_NAME_PARAMETER = 'Parameter';
+const TYPE_NAME_RESPONSE = 'Response';
+const TYPE_NAME_REQUEST_BODY = 'RequestBody';
+const TYPE_NAME_TO_OPTION_COMPONENT_NAME = {
+    [TYPE_NAME_SCHEMA]: 'schemas',
+    [TYPE_NAME_PARAMETER]: 'parameters',
+    [TYPE_NAME_RESPONSE]: 'responses',
+    [TYPE_NAME_REQUEST_BODY]: 'requestBodies',
+};
+const ComponentNameUnique = (options) => {
+    const components = new Map();
+    const typeNames = [];
+    if (options.schemas !== 'off') {
+        typeNames.push(TYPE_NAME_SCHEMA);
+    }
+    if (options.parameters !== 'off') {
+        typeNames.push(TYPE_NAME_PARAMETER);
+    }
+    if (options.responses !== 'off') {
+        typeNames.push(TYPE_NAME_RESPONSE);
+    }
+    if (options.requestBodies !== 'off') {
+        typeNames.push(TYPE_NAME_REQUEST_BODY);
+    }
+    const rule = {
+        ref: {
+            leave(ref, { type, resolve }) {
+                const typeName = type.name;
+                if (typeNames.includes(typeName)) {
+                    const resolvedRef = resolve(ref);
+                    if (!resolvedRef.location)
+                        return;
+                    addComponentFromAbsoluteLocation(typeName, resolvedRef.location.absolutePointer.toString());
+                }
+            },
+        },
+        Root: {
+            leave(root, ctx) {
+                components.forEach((value, key, _) => {
+                    if (value.size > 1) {
+                        const component = getComponentFromKey(key);
+                        const optionComponentName = getOptionComponentNameForTypeName(component.typeName);
+                        const definitions = Array.from(value)
+                            .map((v) => `- ${v}`)
+                            .join('\n');
+                        const problem = {
+                            message: `Component '${optionComponentName}/${component.componentName}' is not unique. It is defined at:\n${definitions}`,
+                        };
+                        const componentSeverity = optionComponentName ? options[optionComponentName] : null;
+                        if (componentSeverity) {
+                            problem.forceSeverity = componentSeverity;
+                        }
+                        ctx.report(problem);
+                    }
+                });
+            },
+        },
+    };
+    if (options.schemas != 'off') {
+        rule.NamedSchemas = {
+            Schema(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_SCHEMA, location.absolutePointer.toString());
+            },
+        };
+    }
+    if (options.responses != 'off') {
+        rule.NamedResponses = {
+            Response(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_RESPONSE, location.absolutePointer.toString());
+            },
+        };
+    }
+    if (options.parameters != 'off') {
+        rule.NamedParameters = {
+            Parameter(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_PARAMETER, location.absolutePointer.toString());
+            },
+        };
+    }
+    if (options.requestBodies != 'off') {
+        rule.NamedRequestBodies = {
+            RequestBody(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_REQUEST_BODY, location.absolutePointer.toString());
+            },
+        };
+    }
+    return rule;
+    function getComponentNameFromAbsoluteLocation(absoluteLocation) {
+        const componentName = absoluteLocation.split('/').slice(-1)[0];
+        if (componentName.endsWith('.yml') ||
+            componentName.endsWith('.yaml') ||
+            componentName.endsWith('.json')) {
+            return componentName.slice(0, componentName.lastIndexOf('.'));
+        }
+        return componentName;
+    }
+    function addFoundComponent(typeName, componentName, absoluteLocation) {
+        var _a;
+        const key = getKeyForComponent(typeName, componentName);
+        const locations = (_a = components.get(key)) !== null && _a !== void 0 ? _a : new Set();
+        locations.add(absoluteLocation);
+        components.set(key, locations);
+    }
+    function addComponentFromAbsoluteLocation(typeName, absoluteLocation) {
+        const componentName = getComponentNameFromAbsoluteLocation(absoluteLocation);
+        addFoundComponent(typeName, componentName, absoluteLocation);
+    }
+};
+exports.ComponentNameUnique = ComponentNameUnique;
+function getOptionComponentNameForTypeName(typeName) {
+    var _a;
+    return (_a = TYPE_NAME_TO_OPTION_COMPONENT_NAME[typeName]) !== null && _a !== void 0 ? _a : null;
+}
+function getKeyForComponent(typeName, componentName) {
+    return `${typeName}/${componentName}`;
+}
+function getComponentFromKey(key) {
+    const [typeName, componentName] = key.split('/');
+    return { typeName, componentName };
+}

package/lib/rules/oas3/index.js

@@ -17,17 +17,16 @@ const operation_operationId_url_safe_1 = require("../common/operation-operationI
 const tags_alphabetical_1 = require("../common/tags-alphabetical");
 const no_server_example_com_1 = require("./no-server-example.com");
 const no_server_trailing_slash_1 = require("./no-server-trailing-slash");
-const info_description_1 = require("../common/info-description");
 const tag_description_1 = require("../common/tag-description");
 const info_contact_1 = require("../common/info-contact");
+const info_license_1 = require("../common/info-license");
 const info_license_url_1 = require("../common/info-license-url");
 const operation_description_1 = require("../common/operation-description");
 const no_unused_components_1 = require("./no-unused-components");
 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 license_url_1 = require("../common/license-url");
-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 boolean_parameter_prefixes_1 = require("./boolean-parameter-prefixes");
 const paths_kebab_case_1 = require("../common/paths-kebab-case");
@@ -39,7 +38,7 @@ const no_undefined_server_variable_1 = require("./no-undefined-server-variable")
 const operation_operationId_1 = require("../common/operation-operationId");
 const operation_summary_1 = require("../common/operation-summary");
 const no_ambiguous_paths_1 = require("../common/no-ambiguous-paths");
-const no_servers_empty_enum_1 = require("./no-servers-empty-enum");
+const no_server_variables_empty_enum_1 = require("./no-server-variables-empty-enum");
 const no_http_verbs_in_paths_1 = require("../common/no-http-verbs-in-paths");
 const request_mime_type_1 = require("./request-mime-type");
 const response_mime_type_1 = require("./response-mime-type");
@@ -47,15 +46,23 @@ const path_segment_plural_1 = require("../common/path-segment-plural");
 const path_excludes_patterns_1 = require("../common/path-excludes-patterns");
 const no_invalid_schema_examples_1 = require("../common/no-invalid-schema-examples");
 const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-examples");
+const response_contains_header_1 = require("../common/response-contains-header");
+const response_contains_property_1 = require("./response-contains-property");
+const scalar_property_missing_example_1 = require("../common/scalar-property-missing-example");
+const spec_components_invalid_map_name_1 = require("./spec-components-invalid-map-name");
+const operation_4xx_problem_details_rfc7807_1 = require("./operation-4xx-problem-details-rfc7807");
+const required_string_property_missing_min_length_1 = require("../common/required-string-property-missing-min-length");
+const spec_strict_refs_1 = require("../common/spec-strict-refs");
+const component_name_unique_1 = require("./component-name-unique");
 exports.rules = {
     spec: spec_1.OasSpec,
-    'info-description': info_description_1.InfoDescription,
     'info-contact': info_contact_1.InfoContact,
-    'info-license': info_license_url_1.InfoLicense,
-    'info-license-url': license_url_1.InfoLicenseUrl,
+    'info-license': info_license_1.InfoLicense,
+    'info-license-url': info_license_url_1.InfoLicenseUrl,
     'operation-2xx-response': operation_2xx_response_1.Operation2xxResponse,
     'operation-4xx-response': operation_4xx_response_1.Operation4xxResponse,
-    'assertions': assertions_1.Assertions,
+    'operation-4xx-problem-details-rfc7807': operation_4xx_problem_details_rfc7807_1.Operation4xxProblemDetailsRfc7807,
+    assertions: assertions_1.Assertions,
     'operation-operationId-unique': operation_operationId_unique_1.OperationIdUnique,
     'operation-parameters-unique': operation_parameters_unique_1.OperationParametersUnique,
     'path-parameters-defined': path_params_defined_1.PathParamsDefined,
@@ -78,7 +85,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,
     'paths-kebab-case': paths_kebab_case_1.PathsKebabCase,
     'boolean-parameter-prefixes': boolean_parameter_prefixes_1.BooleanParameterPrefixes,
@@ -87,7 +94,7 @@ exports.rules = {
     'no-identical-paths': no_identical_paths_1.NoIdenticalPaths,
     'no-ambiguous-paths': no_ambiguous_paths_1.NoAmbiguousPaths,
     'no-undefined-server-variable': no_undefined_server_variable_1.NoUndefinedServerVariable,
-    'no-servers-empty-enum': no_servers_empty_enum_1.NoEmptyEnumServers,
+    'no-server-variables-empty-enum': no_server_variables_empty_enum_1.NoServerVariablesEmptyEnum,
     'no-http-verbs-in-paths': no_http_verbs_in_paths_1.NoHttpVerbsInPaths,
     'path-excludes-patterns': path_excludes_patterns_1.PathExcludesPatterns,
     'request-mime-type': request_mime_type_1.RequestMimeType,
@@ -95,5 +102,12 @@ exports.rules = {
     'path-segment-plural': path_segment_plural_1.PathSegmentPlural,
     'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
     'no-invalid-parameter-examples': no_invalid_parameter_examples_1.NoInvalidParameterExamples,
+    'response-contains-header': response_contains_header_1.ResponseContainsHeader,
+    'response-contains-property': response_contains_property_1.ResponseContainsProperty,
+    'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
+    'spec-components-invalid-map-name': spec_components_invalid_map_name_1.SpecComponentsInvalidMapName,
+    'required-string-property-missing-min-length': required_string_property_missing_min_length_1.RequiredStringPropertyMissingMinLength,
+    'spec-strict-refs': spec_strict_refs_1.SpecStrictRefs,
+    'component-name-unique': component_name_unique_1.ComponentNameUnique,
 };
 exports.preprocessors = {};

package/lib/rules/oas3/no-empty-servers.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoEmptyServers = void 0;
 const NoEmptyServers = () => {
     return {
-        DefinitionRoot(root, { report, location }) {
+        Root(root, { report, location }) {
             if (!root.hasOwnProperty('servers')) {
                 report({
                     message: 'Servers must be present.',
-                    location: location.child(['openapi']).key()
+                    location: location.child(['openapi']).key(),
                 });
                 return;
             }

package/lib/rules/oas3/no-invalid-media-type-examples.js

@@ -5,7 +5,7 @@ const ref_utils_1 = require("../../ref-utils");
 const utils_1 = require("../utils");
 const ValidContentExamples = (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 {
         MediaType: {
             leave(mediaType, ctx) {
@@ -28,7 +28,7 @@ const ValidContentExamples = (opts) => {
                         location = isMultiple ? resolved.location.child('value') : resolved.location;
                         example = resolved.node;
                     }
-                    utils_1.validateExample(isMultiple ? example.value : example, mediaType.schema, location, ctx, disallowAdditionalProperties);
+                    utils_1.validateExample(isMultiple ? example.value : example, mediaType.schema, location, ctx, allowAdditionalProperties);
                 }
             },
         },

package/lib/rules/oas3/no-server-variables-empty-enum.d.ts

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

package/lib/rules/oas3/{no-servers-empty-enum.js → no-server-variables-empty-enum.js}

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoEmptyEnumServers = void 0;
+exports.NoServerVariablesEmptyEnum = void 0;
 var enumError;
 (function (enumError) {
     enumError["empty"] = "empty";
     enumError["invalidDefaultValue"] = "invalidDefaultValue";
 })(enumError || (enumError = {}));
-const NoEmptyEnumServers = () => {
+const NoServerVariablesEmptyEnum = () => {
     return {
-        DefinitionRoot(root, { report, location }) {
+        Root(root, { report, location }) {
             if (!root.servers || root.servers.length === 0)
                 return;
             const invalidVariables = [];
@@ -43,13 +43,13 @@ const NoEmptyEnumServers = () => {
         },
     };
 };
-exports.NoEmptyEnumServers = NoEmptyEnumServers;
+exports.NoServerVariablesEmptyEnum = NoServerVariablesEmptyEnum;
 function checkEnumVariables(server) {
     var _a;
     if (server.variables && Object.keys(server.variables).length === 0)
         return;
     const errors = [];
-    for (var variable in server.variables) {
+    for (const variable in server.variables) {
         const serverVariable = server.variables[variable];
         if (!serverVariable.enum)
             continue;

package/lib/rules/oas3/no-unused-components.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoUnusedComponents = void 0;
 const NoUnusedComponents = () => {
-    let components = new Map();
+    const components = new Map();
     function registerComponent(location, name) {
         var _a;
         components.set(location.absolutePointer, {
@@ -24,7 +24,7 @@ const NoUnusedComponents = () => {
                 });
             }
         },
-        DefinitionRoot: {
+        Root: {
             leave(_, { report }) {
                 components.forEach((usageInfo) => {
                     if (!usageInfo.used) {

package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.d.ts

@@ -0,0 +1,5 @@
+import type { Oas3Rule } from '../../visitors';
+/**
+ * Validation according to rfc7807 - https://datatracker.ietf.org/doc/html/rfc7807
+ */
+export declare const Operation4xxProblemDetailsRfc7807: Oas3Rule;

package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Operation4xxProblemDetailsRfc7807 = void 0;
+const utils_1 = require("../utils");
+/**
+ * Validation according to rfc7807 - https://datatracker.ietf.org/doc/html/rfc7807
+ */
+const Operation4xxProblemDetailsRfc7807 = () => {
+    return {
+        Response: {
+            skip(_, key) {
+                return !/4[Xx0-9]{2}/.test(`${key}`);
+            },
+            enter(response, { report, location }) {
+                if (!response.content || !response.content['application/problem+json'])
+                    report({
+                        message: 'Response `4xx` must have content-type `application/problem+json`.',
+                        location: location.key(),
+                    });
+            },
+            MediaType: {
+                skip(_, key) {
+                    return key !== 'application/problem+json';
+                },
+                enter(media, ctx) {
+                    utils_1.validateDefinedAndNonEmpty('schema', media, ctx);
+                },
+                SchemaProperties(schema, ctx) {
+                    utils_1.validateDefinedAndNonEmpty('type', schema, ctx);
+                    utils_1.validateDefinedAndNonEmpty('title', schema, ctx);
+                },
+            },
+        },
+    };
+};
+exports.Operation4xxProblemDetailsRfc7807 = Operation4xxProblemDetailsRfc7807;

package/lib/rules/oas3/remove-unused-components.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoveUnusedComponents = void 0;
 const utils_1 = require("../../utils");
 const RemoveUnusedComponents = () => {
-    let components = new Map();
+    const components = new Map();
     function registerComponent(location, componentType, name) {
         var _a;
         components.set(location.absolutePointer, {
@@ -24,16 +24,16 @@ const RemoveUnusedComponents = () => {
                         name: key.toString(),
                     });
                 }
-            }
+            },
         },
-        DefinitionRoot: {
+        Root: {
             leave(root, ctx) {
                 const data = ctx.getVisitorData();
                 data.removedCount = 0;
-                components.forEach(usageInfo => {
+                components.forEach((usageInfo) => {
                     const { used, componentType, name } = usageInfo;
-                    if (!used && componentType) {
-                        let componentChild = root.components[componentType];
+                    if (!used && componentType && root.components) {
+                        const componentChild = root.components[componentType];
                         delete componentChild[name];
                         data.removedCount++;
                         if (utils_1.isEmptyObject(componentChild)) {

package/lib/rules/oas3/request-mime-type.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const RequestMimeType: Oas3Rule;

package/lib/rules/oas3/request-mime-type.js

@@ -4,7 +4,7 @@ exports.RequestMimeType = void 0;
 const utils_1 = require("../../utils");
 const RequestMimeType = ({ allowedValues }) => {
     return {
-        PathMap: {
+        Paths: {
             RequestBody: {
                 leave(requestBody, ctx) {
                     utils_1.validateMimeTypeOAS3({ type: 'consumes', value: requestBody }, ctx, allowedValues);

package/lib/rules/oas3/response-contains-property.d.ts

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

package/lib/rules/oas3/response-contains-property.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseContainsProperty = void 0;
+const utils_1 = require("../../utils");
+const ResponseContainsProperty = (options) => {
+    const names = options.names || {};
+    let key;
+    return {
+        Operation: {
+            Response: {
+                skip: (_response, key) => {
+                    return `${key}` === '204';
+                },
+                enter: (_response, ctx) => {
+                    key = ctx.key;
+                },
+                MediaType: {
+                    Schema(schema, { report, location }) {
+                        var _a;
+                        if (schema.type !== 'object')
+                            return;
+                        const expectedProperties = names[key] ||
+                            names[utils_1.getMatchingStatusCodeRange(key)] ||
+                            names[utils_1.getMatchingStatusCodeRange(key).toLowerCase()] ||
+                            [];
+                        for (const expectedProperty of expectedProperties) {
+                            if (!((_a = schema.properties) === null || _a === void 0 ? void 0 : _a[expectedProperty])) {
+                                report({
+                                    message: `Response object must contain a top-level "${expectedProperty}" property.`,
+                                    location: location.child('properties').key(),
+                                });
+                            }
+                        }
+                    },
+                },
+            },
+        },
+    };
+};
+exports.ResponseContainsProperty = ResponseContainsProperty;

package/lib/rules/oas3/response-mime-type.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const ResponseMimeType: Oas3Rule;

package/lib/rules/oas3/response-mime-type.js

@@ -4,7 +4,7 @@ exports.ResponseMimeType = void 0;
 const utils_1 = require("../../utils");
 const ResponseMimeType = ({ allowedValues }) => {
     return {
-        PathMap: {
+        Paths: {
             Response: {
                 leave(response, ctx) {
                     utils_1.validateMimeTypeOAS3({ type: 'produces', value: response }, ctx, allowedValues);

package/lib/rules/oas3/spec-components-invalid-map-name.d.ts

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

package/lib/rules/oas3/spec-components-invalid-map-name.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecComponentsInvalidMapName = void 0;
+const SpecComponentsInvalidMapName = () => {
+    const KEYS_REGEX = '^[a-zA-Z0-9\\.\\-_]+$';
+    function validateKey(key, report, location, component) {
+        if (!new RegExp(KEYS_REGEX).test(key)) {
+            report({
+                message: `The map key in ${component} "${key}" does not match the regular expression "${KEYS_REGEX}"`,
+                location: location.key(),
+            });
+        }
+    }
+    return {
+        NamedSchemas: {
+            Schema(_node, { key, report, location }) {
+                validateKey(key, report, location, 'schemas');
+            },
+        },
+        NamedParameters: {
+            Parameter(_node, { key, report, location }) {
+                validateKey(key, report, location, 'parameters');
+            },
+        },
+        NamedResponses: {
+            Response(_node, { key, report, location }) {
+                validateKey(key, report, location, 'responses');
+            },
+        },
+        NamedExamples: {
+            Example(_node, { key, report, location }) {
+                validateKey(key, report, location, 'examples');
+            },
+        },
+        NamedRequestBodies: {
+            RequestBody(_node, { key, report, location }) {
+                validateKey(key, report, location, 'requestBodies');
+            },
+        },
+        NamedHeaders: {
+            Header(_node, { key, report, location }) {
+                validateKey(key, report, location, 'headers');
+            },
+        },
+        NamedSecuritySchemes: {
+            SecurityScheme(_node, { key, report, location }) {
+                validateKey(key, report, location, 'securitySchemes');
+            },
+        },
+        NamedLinks: {
+            Link(_node, { key, report, location }) {
+                validateKey(key, report, location, 'links');
+            },
+        },
+        NamedCallbacks: {
+            Callback(_node, { key, report, location }) {
+                validateKey(key, report, location, 'callbacks');
+            },
+        },
+    };
+};
+exports.SpecComponentsInvalidMapName = SpecComponentsInvalidMapName;

package/lib/rules/other/stats.d.ts

@@ -14,7 +14,7 @@ export declare const Stats: (statsAccumulator: StatsAccumulator) => {
     Link: {
         leave(link: any): void;
     };
-    DefinitionRoot: {
+    Root: {
         leave(): void;
     };
     WebhooksMap: {
@@ -22,7 +22,7 @@ export declare const Stats: (statsAccumulator: StatsAccumulator) => {
             leave(operation: any): void;
         };
     };
-    PathMap: {
+    Paths: {
         PathItem: {
             leave(): void;
             Operation: {

package/lib/rules/other/stats.js

@@ -3,11 +3,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Stats = void 0;
 const Stats = (statsAccumulator) => {
     return {
-        ExternalDocs: { leave() { statsAccumulator.externalDocs.total++; } },
-        ref: { enter(ref) { statsAccumulator.refs.items.add(ref['$ref']); } },
-        Tag: { leave(tag) { statsAccumulator.tags.items.add(tag.name); } },
-        Link: { leave(link) { statsAccumulator.links.items.add(link.operationId); } },
-        DefinitionRoot: {
+        ExternalDocs: {
+            leave() {
+                statsAccumulator.externalDocs.total++;
+            },
+        },
+        ref: {
+            enter(ref) {
+                statsAccumulator.refs.items.add(ref['$ref']);
+            },
+        },
+        Tag: {
+            leave(tag) {
+                statsAccumulator.tags.items.add(tag.name);
+            },
+        },
+        Link: {
+            leave(link) {
+                statsAccumulator.links.items.add(link.operationId);
+            },
+        },
+        Root: {
             leave() {
                 statsAccumulator.parameters.total = statsAccumulator.parameters.items.size;
                 statsAccumulator.refs.total = statsAccumulator.refs.items.size;
@@ -18,27 +34,40 @@ const Stats = (statsAccumulator) => {
         WebhooksMap: {
             Operation: {
                 leave(operation) {
-                    operation.tags.forEach((tag) => { statsAccumulator.tags.items.add(tag); });
-                }
-            }
+                    operation.tags.forEach((tag) => {
+                        statsAccumulator.tags.items.add(tag);
+                    });
+                },
+            },
         },
-        PathMap: {
+        Paths: {
             PathItem: {
-                leave() { statsAccumulator.pathItems.total++; },
+                leave() {
+                    statsAccumulator.pathItems.total++;
+                },
                 Operation: {
                     leave(operation) {
                         statsAccumulator.operations.total++;
-                        operation.tags && operation.tags.forEach((tag) => { statsAccumulator.tags.items.add(tag); });
-                    }
+                        operation.tags &&
+                            operation.tags.forEach((tag) => {
+                                statsAccumulator.tags.items.add(tag);
+                            });
+                    },
                 },
-                Parameter: { leave(parameter) {
+                Parameter: {
+                    leave(parameter) {
                         statsAccumulator.parameters.items.add(parameter.name);
-                    } },
+                    },
+                },
             },
         },
         NamedSchemas: {
-            Schema: { leave() { statsAccumulator.schemas.total++; } }
-        }
+            Schema: {
+                leave() {
+                    statsAccumulator.schemas.total++;
+                },
+            },
+        },
     };
 };
 exports.Stats = Stats;

package/lib/rules/utils.d.ts

@@ -1,7 +1,7 @@
 import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
 import { Oas3Schema, Referenced } from '../typings/openapi';
-export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array" | "null";
+export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "null" | "integer" | "array";
 /**
  * Checks if value matches specified JSON schema type
  *
@@ -14,4 +14,7 @@ export declare function missingRequiredField(type: string, field: string): strin
 export declare function fieldNonEmpty(type: string, field: string): string;
 export declare function validateDefinedAndNonEmpty(fieldName: string, value: any, ctx: UserContext): void;
 export declare function getSuggest(given: string, variants: string[]): string[];
-export declare function validateExample(example: any, schema: Referenced<Oas3Schema>, dataLoc: Location, { resolve, location, report }: UserContext, disallowAdditionalProperties: boolean): void;
+export declare function validateExample(example: any, schema: Referenced<Oas3Schema>, dataLoc: Location, { resolve, location, report }: UserContext, allowAdditionalProperties: boolean): void;
+export declare function getAdditionalPropertiesOption(opts: Record<string, any>): boolean;
+export declare function validateSchemaEnumType(schemaEnum: string[], propertyValue: string, propName: string, refLocation: Location | undefined, { report, location }: UserContext): void;
+export declare function validateResponseCodes(responseCodes: string[], codeRange: string, { report }: UserContext): void;