@redocly/openapi-core 1.0.0-beta.99 → 1.0.0-rc.2

package/lib/rules/utils.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateExample = exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
+exports.validateResponseCodes = exports.validateSchemaEnumType = exports.getAdditionalPropertiesOption = exports.validateExample = exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
 const levenshtein = require("js-levenshtein");
 const ref_utils_1 = require("../ref-utils");
 const ajv_1 = require("./ajv");
+const utils_1 = require("../utils");
 function oasTypeOf(value) {
     if (Array.isArray(value)) {
         return 'array';
@@ -11,6 +12,9 @@ function oasTypeOf(value) {
     else if (value === null) {
         return 'null';
     }
+    else if (Number.isInteger(value)) {
+        return 'integer';
+    }
     else {
         return typeof value;
     }
@@ -25,7 +29,7 @@ exports.oasTypeOf = oasTypeOf;
  */
 function matchesJsonSchemaType(value, type, nullable) {
     if (nullable && value === null) {
-        return value === null;
+        return true;
     }
     switch (type) {
         case 'array':
@@ -68,6 +72,8 @@ function validateDefinedAndNonEmpty(fieldName, value, ctx) {
 }
 exports.validateDefinedAndNonEmpty = validateDefinedAndNonEmpty;
 function getSuggest(given, variants) {
+    if (given === null)
+        return variants;
     if (typeof given !== 'string' || !variants.length)
         return [];
     const distances = [];
@@ -82,14 +88,14 @@ function getSuggest(given, variants) {
     return distances.map((d) => d.variant);
 }
 exports.getSuggest = getSuggest;
-function validateExample(example, schema, dataLoc, { resolve, location, report }, disallowAdditionalProperties) {
+function validateExample(example, schema, dataLoc, { resolve, location, report }, allowAdditionalProperties) {
     try {
-        const { valid, errors } = ajv_1.validateJsonSchema(example, schema, location.child('schema'), dataLoc.pointer, resolve, disallowAdditionalProperties);
+        const { valid, errors } = ajv_1.validateJsonSchema(example, schema, location.child('schema'), dataLoc.pointer, resolve, allowAdditionalProperties);
         if (!valid) {
-            for (let error of errors) {
+            for (const error of errors) {
                 report({
                     message: `Example value must conform to the schema: ${error.message}.`,
-                    location: Object.assign(Object.assign({}, new ref_utils_1.Location(dataLoc.source, error.instancePath)), { reportOnKey: error.keyword === 'additionalProperties' }),
+                    location: Object.assign(Object.assign({}, new ref_utils_1.Location(dataLoc.source, error.instancePath)), { reportOnKey: error.keyword === 'unevaluatedProperties' || error.keyword === 'additionalProperties' }),
                     from: location,
                     suggest: error.suggest,
                 });
@@ -97,6 +103,9 @@ function validateExample(example, schema, dataLoc, { resolve, location, report }
         }
     }
     catch (e) {
+        if (e.message === 'discriminator: requires oneOf or anyOf composite keyword') {
+            return;
+        }
         report({
             message: `Example validation errored: ${e.message}.`,
             location: location.child('schema'),
@@ -105,3 +114,42 @@ function validateExample(example, schema, dataLoc, { resolve, location, report }
     }
 }
 exports.validateExample = validateExample;
+function getAdditionalPropertiesOption(opts) {
+    if (opts.disallowAdditionalProperties === undefined) {
+        return opts.allowAdditionalProperties;
+    }
+    if (opts.allowAdditionalProperties !== undefined) {
+        utils_1.showErrorForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties', undefined);
+    }
+    utils_1.showWarningForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties');
+    return !opts.disallowAdditionalProperties;
+}
+exports.getAdditionalPropertiesOption = getAdditionalPropertiesOption;
+function validateSchemaEnumType(schemaEnum, propertyValue, propName, refLocation, { report, location }) {
+    if (!schemaEnum) {
+        return;
+    }
+    if (!schemaEnum.includes(propertyValue)) {
+        report({
+            location,
+            message: `\`${propName}\` can be one of the following only: ${schemaEnum
+                .map((type) => `"${type}"`)
+                .join(', ')}.`,
+            from: refLocation,
+            suggest: getSuggest(propertyValue, schemaEnum),
+        });
+    }
+}
+exports.validateSchemaEnumType = validateSchemaEnumType;
+function validateResponseCodes(responseCodes, codeRange, { report }) {
+    const responseCodeRegexp = new RegExp(`^${codeRange[0]}[0-9Xx]{2}$`);
+    const containsNeededCode = responseCodes.some((code) => (codeRange === '2XX' && code === 'default') || // It's OK to replace 2xx codes with the default
+        responseCodeRegexp.test(code));
+    if (!containsNeededCode) {
+        report({
+            message: `Operation must have at least one \`${codeRange}\` response.`,
+            location: { reportOnKey: true },
+        });
+    }
+}
+exports.validateResponseCodes = validateResponseCodes;