Adds 3.1.0 dependentRequired (#212)

* Writes out dependent_required info in two schemas

* Adds tests of dependent_required component schemas

* Samples regen

* Adds DependentRequired schema feature and turns it on in python generator docs

Author: spacether

docs/generators/java.md

@@ -319,6 +319,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
+|DependentRequired|✗|OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3
 |ExclusiveMinimum|✓|OAS2,OAS3

docs/generators/jaxrs-jersey.md

@@ -302,6 +302,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
+|DependentRequired|✗|OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3
 |ExclusiveMinimum|✓|OAS2,OAS3

docs/generators/jmeter.md

@@ -161,6 +161,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
+|DependentRequired|✗|OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3
 |ExclusiveMinimum|✓|OAS2,OAS3

docs/generators/kotlin.md

@@ -271,6 +271,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
+|DependentRequired|✗|OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3
 |ExclusiveMinimum|✓|OAS2,OAS3

docs/generators/python.md

@@ -230,6 +230,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |Const|✓|OAS3
 |Contains|✓|OAS3
 |Default|✓|OAS2,OAS3
+|DependentRequired|✓|OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3
 |ExclusiveMinimum|✓|OAS2,OAS3

samples/client/3_0_3_unit_test/python/src/unit_test_api/configurations/schema_configuration.py

@@ -18,6 +18,7 @@
     'any_of': 'anyOf',
     'const_value_to_name': 'const',
     'contains': 'contains',
+    'dependent_required': 'dependentRequired',
     'discriminator': 'discriminator',
     # default omitted because it has no validation impact
     'enum_value_to_name': 'enum',

samples/client/3_0_3_unit_test/python/src/unit_test_api/schemas/validation.py

@@ -1061,6 +1061,26 @@ def validate_const(
     return None
 
 
+def validate_dependent_required(
+    arg: typing.Any,
+    dependent_required: typing.Mapping[str, typing.Set[str]],
+    cls: typing.Type,
+    validation_metadata: ValidationMetadata,
+) -> None:
+    if not isinstance(arg, immutabledict):
+        return None
+    for key, keys_that_must_exist in dependent_required.items():
+        if key not in arg:
+            continue
+        missing_keys = keys_that_must_exist - arg.keys()
+        if missing_keys:
+            raise exceptions.ApiValueError(
+                f"Validation failed for dependentRequired because these_keys={missing_keys} are "
+                f"missing at path_to_item={validation_metadata.path_to_item} in class {cls}"
+            )
+    return None
+
+
 validator_type = typing.Callable[[typing.Any, typing.Any, type, ValidationMetadata], typing.Optional[PathToSchemasType]]
 json_schema_keyword_to_validator: typing.Mapping[str, validator_type] = {
     'types': validate_types,
@@ -1092,4 +1112,5 @@ def validate_const(
     'min_contains': validate_min_contains,
     'max_contains': validate_max_contains,
     'const_value_to_name': validate_const,
+    'dependent_required': validate_dependent_required,
 }

samples/client/3_1_0_json_schema/python/.openapi-generator/FILES

@@ -5,11 +5,13 @@ README.md
 docs/apis/tags/default_api.md
 docs/components/schema/any_type_const_string.md
 docs/components/schema/any_type_contains_value.md
+docs/components/schema/any_type_dependent_required.md
 docs/components/schema/any_type_max_contains_value.md
 docs/components/schema/any_type_min_contains_value.md
 docs/components/schema/array_contains_value.md
 docs/components/schema/array_max_contains_value.md
 docs/components/schema/array_min_contains_value.md
+docs/components/schema/object_dependent_required.md
 docs/components/schema/string_const_string.md
 docs/paths/some_path/get.md
 docs/paths/some_path/get/responses/response_200/content/application_json/schema.md
@@ -33,11 +35,13 @@ src/json_schema_api/components/__init__.py
 src/json_schema_api/components/schema/__init__.py
 src/json_schema_api/components/schema/any_type_const_string.py
 src/json_schema_api/components/schema/any_type_contains_value.py
+src/json_schema_api/components/schema/any_type_dependent_required.py
 src/json_schema_api/components/schema/any_type_max_contains_value.py
 src/json_schema_api/components/schema/any_type_min_contains_value.py
 src/json_schema_api/components/schema/array_contains_value.py
 src/json_schema_api/components/schema/array_max_contains_value.py
 src/json_schema_api/components/schema/array_min_contains_value.py
+src/json_schema_api/components/schema/object_dependent_required.py
 src/json_schema_api/components/schema/string_const_string.py
 src/json_schema_api/components/schemas/__init__.py
 src/json_schema_api/configurations/__init__.py

samples/client/3_1_0_json_schema/python/README.md

@@ -175,11 +175,13 @@ Class | Description
 ----- | ------------
 [AnyTypeConstString](docs/components/schema/any_type_const_string.md) |
 [AnyTypeContainsValue](docs/components/schema/any_type_contains_value.md) |
+[AnyTypeDependentRequired](docs/components/schema/any_type_dependent_required.md) |
 [AnyTypeMaxContainsValue](docs/components/schema/any_type_max_contains_value.md) |
 [AnyTypeMinContainsValue](docs/components/schema/any_type_min_contains_value.md) |
 [ArrayContainsValue](docs/components/schema/array_contains_value.md) |
 [ArrayMaxContainsValue](docs/components/schema/array_max_contains_value.md) |
 [ArrayMinContainsValue](docs/components/schema/array_min_contains_value.md) |
+[ObjectDependentRequired](docs/components/schema/object_dependent_required.md) |
 [StringConstString](docs/components/schema/string_const_string.md) |
 
 ## Notes for Large OpenAPI documents

samples/client/3_1_0_json_schema/python/docs/components/schema/any_type_dependent_required.md

@@ -0,0 +1,12 @@
+# AnyTypeDependentRequired
+json_schema_api.components.schema.any_type_dependent_required
+```
+type: schemas.Schema
+```
+
+## validate method
+Input Type | Return Type | Notes
+------------ | ------------- | -------------
+dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |
+
+[[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)