Enforce properties required flag

Author: p1c2u

openapi_schema_validator/shortcuts.py

@@ -12,6 +12,9 @@
 from openapi_schema_validator._dialects import OAS31_BASE_DIALECT_ID
 from openapi_schema_validator._dialects import OAS32_BASE_DIALECT_ID
 from openapi_schema_validator.validators import OAS32Validator
+from openapi_schema_validator.validators import (
+    build_enforce_properties_required_validator,
+)
 from openapi_schema_validator.validators import check_openapi_schema
 
 _LOCAL_ONLY_REGISTRY = Registry()
@@ -42,6 +45,7 @@ def validate(
     *args: Any,
     allow_remote_references: bool = False,
     check_schema: bool = True,
+    enforce_properties_required: bool = False,
     **kwargs: Any,
 ) -> None:
     """
@@ -74,6 +78,9 @@ def validate(
         jsonschema.exceptions.SchemaError: If ``schema`` is invalid.
         jsonschema.exceptions.ValidationError: If ``instance`` is invalid.
     """
+    if enforce_properties_required:
+        cls = build_enforce_properties_required_validator(cls)  # type: ignore[arg-type]
+
     schema_dict = cast(dict[str, Any], schema)
 
     validator_kwargs = kwargs.copy()

openapi_schema_validator/validators.py

@@ -1,10 +1,14 @@
+from functools import lru_cache
 from typing import Any
+from typing import Iterator
+from typing import Mapping
 from typing import cast
 
 from jsonschema import _keywords
 from jsonschema import _legacy_keywords
 from jsonschema.exceptions import SchemaError
 from jsonschema.exceptions import ValidationError
+from jsonschema.protocols import Validator
 from jsonschema.validators import Draft202012Validator
 from jsonschema.validators import create
 from jsonschema.validators import extend
@@ -187,3 +191,47 @@ def _build_oas32_validator() -> Any:
 OAS30Validator.check_schema = classmethod(check_openapi_schema)
 OAS31Validator.check_schema = classmethod(check_openapi_schema)
 OAS32Validator.check_schema = classmethod(check_openapi_schema)
+
+
+@lru_cache(maxsize=None)
+def build_enforce_properties_required_validator(
+    validator_class: Any,
+) -> type[Validator]:
+    properties_validator = validator_class.VALIDATORS.get("properties")
+    required_validator = validator_class.VALIDATORS.get("required")
+
+    def enforce_properties(
+        validator: Any,
+        properties: Any,
+        instance: Any,
+        schema: Mapping[str, Any],
+    ) -> Iterator[Any]:
+        if properties_validator is not None:
+            yield from properties_validator(
+                validator, properties, instance, schema
+            )
+
+        if not validator.is_type(instance, "object"):
+            return
+
+        if required_validator is not None:
+            schema_required = (
+                schema.get("required", []) if isinstance(schema, dict) else []
+            )
+            missing_props = [
+                p for p in properties.keys() if p not in schema_required
+            ]
+            if missing_props:
+                yield from required_validator(
+                    validator, missing_props, instance, schema
+                )
+
+    extended_validator = extend(
+        validator_class,
+        validators={"properties": enforce_properties},
+    )
+    if hasattr(validator_class, "check_schema"):
+        extended_validator.check_schema = classmethod(
+            validator_class.check_schema.__func__
+        )
+    return cast(type[Validator], extended_validator)

tests/unit/test_shortcut.py

@@ -195,3 +195,32 @@ def test_validate_cache_max_size_from_env(monkeypatch):
         validate("foo", schema_a, cls=OAS32Validator)
 
     assert check_schema_mock.call_count == 3
+
+
+from openapi_schema_validator.validators import OAS30Validator
+
+
+def test_enforce_properties_required():
+    schema = {
+        "type": "object",
+        "properties": {
+            "id": {"type": "string"},
+            "nickname": {"type": "string"},
+        },
+        "required": ["id"],
+    }
+    instance = {"id": "42"}  # nickname missing
+
+    # Should be valid normally
+    validate(instance, schema, cls=OAS30Validator)
+
+    # Should fail with opt-in flag
+    with pytest.raises(ValidationError) as exc:
+        validate(
+            instance,
+            schema,
+            cls=OAS30Validator,
+            enforce_properties_required=True,
+        )
+
+    assert "'nickname' is a required property" in str(exc.value)