fix: introduce new built-in rule for missing required schema properti…

…es (#1412) * fix: introduce new custom rule for missing required schema properties, along along with tests and changeset * fix: add code implementation to cover anyOf keyword schema nestings, add more tests
Redocly · Feb 13, 2024 · 4d01896 · 4d01896 · github-actions · Feb 13, 2024
1 parent fd79f7d
commit 4d01896
Show file tree

Hide file tree

Showing 11 changed files with 619 additions and 0 deletions.
diff --git a/.changeset/lemon-onions-approve.md b/.changeset/lemon-onions-approve.md
@@ -0,0 +1,5 @@
+---
+"@redocly/openapi-core": minor
+---
+
+Added new `no-required-schema-properties-undefined` rule to check if each required schema property is defined.
diff --git a/packages/core/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap b/packages/core/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",

diff --git a/packages/core/src/config/all.ts b/packages/core/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',

diff --git a/packages/core/src/config/minimal.ts b/packages/core/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',

diff --git a/packages/core/src/config/recommended-strict.ts b/packages/core/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',

diff --git a/packages/core/src/config/recommended.ts b/packages/core/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',
St.^❔	Category	Percentage	Covered / Total
🟡	Statements	76.19%	4322/5673
🟡	Branches	65.94%	2254/3418
🟡	Functions	68.9%	698/1013
🟡	Lines	76.39%	4063/5319