@redocly/openapi-core 1.8.2 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @redocly/openapi-core
 
+## 1.9.0
+
+### Minor Changes
+
+- Added new `no-required-schema-properties-undefined` rule to check if each required schema property is defined.
+
+### Patch Changes
+
+- Fixed an issue where `$ref`s ending in `#` (instead of `#/`) would break the application.
+
 ## 1.8.2
 
 ## 1.8.1

package/lib/config/all.js

@@ -43,6 +43,7 @@ const all = {
         'path-params-defined': 'error',
         'required-string-property-missing-min-length': 'error',
         'response-contains-header': 'error',
+        'no-required-schema-properties-undefined': 'error',
     },
     oas2Rules: {
         'boolean-parameter-prefixes': 'error',

package/lib/config/minimal.js

@@ -40,6 +40,7 @@ const minimal = {
         'response-contains-header': 'off',
         'path-segment-plural': 'off',
         'scalar-property-missing-example': 'off',
+        'no-required-schema-properties-undefined': 'off',
     },
     oas2Rules: {
         'boolean-parameter-prefixes': 'off',

package/lib/config/recommended-strict.js

@@ -40,6 +40,7 @@ const recommendedStrict = {
         'required-string-property-missing-min-length': 'off',
         'response-contains-header': 'off',
         'scalar-property-missing-example': 'off',
+        'no-required-schema-properties-undefined': 'off',
     },
     oas2Rules: {
         'boolean-parameter-prefixes': 'off',

package/lib/config/recommended.js

@@ -40,6 +40,7 @@ const recommended = {
         'required-string-property-missing-min-length': 'off',
         'response-contains-header': 'off',
         'scalar-property-missing-example': 'off',
+        'no-required-schema-properties-undefined': 'off',
     },
     oas2Rules: {
         'boolean-parameter-prefixes': 'off',

package/lib/ref-utils.js

@@ -39,15 +39,15 @@ function escapePointer(fragment) {
 }
 exports.escapePointer = escapePointer;
 function parseRef(ref) {
-    const [uri, pointer] = ref.split('#/');
+    const [uri, pointer = ''] = ref.split('#');
     return {
         uri: uri || null,
-        pointer: pointer ? pointer.split('/').map(unescapePointer).filter(utils_1.isTruthy) : [],
+        pointer: parsePointer(pointer),
     };
 }
 exports.parseRef = parseRef;
 function parsePointer(pointer) {
-    return pointer.substr(2).split('/').map(unescapePointer);
+    return pointer.split('/').map(unescapePointer).filter(utils_1.isTruthy);
 }
 exports.parsePointer = parsePointer;
 function pointerBaseName(pointer) {

package/lib/rules/common/no-required-schema-properties-undefined.d.ts

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

package/lib/rules/common/no-required-schema-properties-undefined.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoRequiredSchemaPropertiesUndefined = void 0;
+const ref_utils_1 = require("../../ref-utils");
+const NoRequiredSchemaPropertiesUndefined = () => {
+    return {
+        Schema: {
+            enter(schema, { location, report, resolve }) {
+                if (!schema.required)
+                    return;
+                const visitedSchemas = new Set();
+                const elevateProperties = (schema) => {
+                    var _a, _b, _c, _d;
+                    // Check if the schema has been visited before processing it
+                    if (visitedSchemas.has(schema)) {
+                        return {};
+                    }
+                    visitedSchemas.add(schema);
+                    if ((0, ref_utils_1.isRef)(schema)) {
+                        return elevateProperties(resolve(schema).node);
+                    }
+                    return Object.assign({}, schema.properties, ...((_b = (_a = schema.allOf) === null || _a === void 0 ? void 0 : _a.map(elevateProperties)) !== null && _b !== void 0 ? _b : []), ...((_d = (_c = schema.anyOf) === null || _c === void 0 ? void 0 : _c.map(elevateProperties)) !== null && _d !== void 0 ? _d : []));
+                };
+                const allProperties = elevateProperties(schema);
+                for (const [i, requiredProperty] of schema.required.entries()) {
+                    if (!allProperties || allProperties[requiredProperty] === undefined) {
+                        report({
+                            message: `Required property '${requiredProperty}' is undefined.`,
+                            location: location.child(['required', i]),
+                        });
+                    }
+                }
+            },
+        },
+    };
+};
+exports.NoRequiredSchemaPropertiesUndefined = NoRequiredSchemaPropertiesUndefined;

package/lib/rules/oas2/index.js

@@ -43,6 +43,7 @@ const response_contains_property_1 = require("./response-contains-property");
 const scalar_property_missing_example_1 = require("../common/scalar-property-missing-example");
 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 no_required_schema_properties_undefined_1 = require("../common/no-required-schema-properties-undefined");
 exports.rules = {
     spec: spec_1.Spec,
     'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
@@ -87,5 +88,6 @@ exports.rules = {
     'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
     'required-string-property-missing-min-length': required_string_property_missing_min_length_1.RequiredStringPropertyMissingMinLength,
     'spec-strict-refs': spec_strict_refs_1.SpecStrictRefs,
+    'no-required-schema-properties-undefined': no_required_schema_properties_undefined_1.NoRequiredSchemaPropertiesUndefined,
 };
 exports.preprocessors = {};

package/lib/rules/oas3/index.js

@@ -55,6 +55,7 @@ const required_string_property_missing_min_length_1 = require("../common/require
 const spec_strict_refs_1 = require("../common/spec-strict-refs");
 const component_name_unique_1 = require("./component-name-unique");
 const array_parameter_serialization_1 = require("./array-parameter-serialization");
+const no_required_schema_properties_undefined_1 = require("../common/no-required-schema-properties-undefined");
 exports.rules = {
     spec: spec_1.Spec,
     'info-contact': info_contact_1.InfoContact,
@@ -111,5 +112,6 @@ exports.rules = {
     'spec-strict-refs': spec_strict_refs_1.SpecStrictRefs,
     'component-name-unique': component_name_unique_1.ComponentNameUnique,
     'array-parameter-serialization': array_parameter_serialization_1.ArrayParameterSerialization,
+    'no-required-schema-properties-undefined': no_required_schema_properties_undefined_1.NoRequiredSchemaPropertiesUndefined,
 };
 exports.preprocessors = {};

package/lib/types/redocly-yaml.d.ts

@@ -1,7 +1,7 @@
 import { NodeType } from '.';
 declare const builtInCommonRules: readonly ["spec", "info-contact", "operation-operationId", "tag-description", "tags-alphabetical"];
 export type BuiltInCommonRuleId = typeof builtInCommonRules[number];
-declare const builtInCommonOASRules: readonly ["info-license-url", "info-license", "no-ambiguous-paths", "no-enum-type-mismatch", "no-http-verbs-in-paths", "no-identical-paths", "no-invalid-parameter-examples", "no-invalid-schema-examples", "no-path-trailing-slash", "operation-2xx-response", "operation-4xx-response", "operation-description", "operation-operationId-unique", "operation-operationId-url-safe", "operation-parameters-unique", "operation-singular-tag", "operation-summary", "operation-tag-defined", "parameter-description", "path-declaration-must-exist", "path-excludes-patterns", "path-http-verbs-order", "path-not-include-query", "path-params-defined", "path-parameters-defined", "path-segment-plural", "paths-kebab-case", "required-string-property-missing-min-length", "response-contains-header", "scalar-property-missing-example", "security-defined", "spec-strict-refs", "no-unresolved-refs"];
+declare const builtInCommonOASRules: readonly ["info-license-url", "info-license", "no-ambiguous-paths", "no-enum-type-mismatch", "no-http-verbs-in-paths", "no-identical-paths", "no-invalid-parameter-examples", "no-invalid-schema-examples", "no-path-trailing-slash", "operation-2xx-response", "operation-4xx-response", "operation-description", "operation-operationId-unique", "operation-operationId-url-safe", "operation-parameters-unique", "operation-singular-tag", "operation-summary", "operation-tag-defined", "parameter-description", "path-declaration-must-exist", "path-excludes-patterns", "path-http-verbs-order", "path-not-include-query", "path-params-defined", "path-parameters-defined", "path-segment-plural", "paths-kebab-case", "required-string-property-missing-min-length", "response-contains-header", "scalar-property-missing-example", "security-defined", "spec-strict-refs", "no-unresolved-refs", "no-required-schema-properties-undefined"];
 export type BuiltInCommonOASRuleId = typeof builtInCommonOASRules[number];
 declare const builtInOAS2Rules: readonly ["boolean-parameter-prefixes", "request-mime-type", "response-contains-property", "response-mime-type"];
 export type BuiltInOAS2RuleId = typeof builtInOAS2Rules[number];

package/lib/types/redocly-yaml.js

@@ -47,6 +47,7 @@ const builtInCommonOASRules = [
     'security-defined',
     'spec-strict-refs',
     'no-unresolved-refs',
+    'no-required-schema-properties-undefined',
 ];
 const builtInOAS2Rules = [
     'boolean-parameter-prefixes',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {

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

@@ -74,6 +74,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "no-invalid-parameter-examples": "off",
     "no-invalid-schema-examples": "off",
     "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
     "no-unresolved-refs": "error",
     "operation-2xx-response": "warn",
     "operation-4xx-response": "error",
@@ -198,6 +199,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "no-invalid-parameter-examples": "off",
     "no-invalid-schema-examples": "off",
     "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
     "no-unresolved-refs": "error",
     "operation-2xx-response": "error",
     "operation-4xx-response": "off",

package/src/config/all.ts

@@ -43,6 +43,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'path-params-defined': 'error',
     'required-string-property-missing-min-length': 'error',
     'response-contains-header': 'error',
+    'no-required-schema-properties-undefined': 'error',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'error',

package/src/config/minimal.ts

@@ -40,6 +40,7 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'response-contains-header': 'off',
     'path-segment-plural': 'off',
     'scalar-property-missing-example': 'off',
+    'no-required-schema-properties-undefined': 'off',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'off',

package/src/config/recommended-strict.ts

@@ -40,6 +40,7 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'required-string-property-missing-min-length': 'off',
     'response-contains-header': 'off',
     'scalar-property-missing-example': 'off',
+    'no-required-schema-properties-undefined': 'off',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'off',

package/src/config/recommended.ts

@@ -40,6 +40,7 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'required-string-property-missing-min-length': 'off',
     'response-contains-header': 'off',
     'scalar-property-missing-example': 'off',
+    'no-required-schema-properties-undefined': 'off',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'off',

package/src/ref-utils.ts

@@ -43,15 +43,15 @@ export function escapePointer<T extends string | number>(fragment: T): T {
 }
 
 export function parseRef(ref: string): { uri: string | null; pointer: string[] } {
-  const [uri, pointer] = ref.split('#/');
+  const [uri, pointer = ''] = ref.split('#');
   return {
     uri: uri || null,
-    pointer: pointer ? pointer.split('/').map(unescapePointer).filter(isTruthy) : [],
+    pointer: parsePointer(pointer),
   };
 }
 
 export function parsePointer(pointer: string) {
-  return pointer.substr(2).split('/').map(unescapePointer);
+  return pointer.split('/').map(unescapePointer).filter(isTruthy);
 }
 
 export function pointerBaseName(pointer: string) {