Adds 3.1.0 dependent schemas (#214)

* Adds dependentSchemas data store and writes to it

* Fixes input param name in javadoc

* Adds two test schemas to th 310 spec file for dependentSchemas

* Writes out dependend schema info in the schema class

* Writes out dependentSchemas inline schemas in py files

* Adds validate_dependent_schemas

* Adds python tests

* Adds keyword to list of disableable ones, adds schem feature property for docs and turns it on in python generator

* Sample regen

* Docs regen

Author: spacether

docs/generators/java.md

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

docs/generators/jaxrs-jersey.md

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

docs/generators/jmeter.md

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

docs/generators/kotlin.md

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

docs/generators/python.md

@@ -231,6 +231,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |Contains|✓|OAS3
 |Default|✓|OAS2,OAS3
 |DependentRequired|✓|OAS3
+|DependentSchemas|✓|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

@@ -19,6 +19,7 @@
     'const_value_to_name': 'const',
     'contains': 'contains',
     'dependent_required': 'dependentRequired',
+    'dependent_schemas': 'dependentSchemas',
     '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

@@ -1081,6 +1081,28 @@ def validate_dependent_required(
     return None
 
 
+def validate_dependent_schemas(
+    arg: typing.Any,
+    dependent_schemas: typing.Mapping[str, typing.Type[SchemaValidator]],
+    cls: typing.Type,
+    validation_metadata: ValidationMetadata,
+) -> typing.Optional[PathToSchemasType]:
+    if not isinstance(arg, immutabledict):
+        return None
+    path_to_schemas: PathToSchemasType = {}
+    module_namespace = vars(sys.modules[cls.__module__])
+    for key, schema in dependent_schemas.items():
+        if key not in arg:
+            continue
+        schema = _get_class(schema, module_namespace)
+        if validation_metadata.validation_ran_earlier(schema):
+            add_deeper_validated_schemas(validation_metadata, path_to_schemas)
+            continue
+        other_path_to_schemas = schema._validate(arg, validation_metadata=validation_metadata)
+        update(path_to_schemas, other_path_to_schemas)
+    return path_to_schemas
+
+
 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,
@@ -1113,4 +1135,5 @@ def validate_dependent_required(
     'max_contains': validate_max_contains,
     'const_value_to_name': validate_const,
     'dependent_required': validate_dependent_required,
+    'dependent_schemas': validate_dependent_schemas
 }

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

@@ -6,12 +6,14 @@ 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_dependent_schemas.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/object_dependent_schemas.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
@@ -36,12 +38,14 @@ 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_dependent_schemas.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/object_dependent_schemas.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

@@ -176,12 +176,14 @@ 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) |
+[AnyTypeDependentSchemas](docs/components/schema/any_type_dependent_schemas.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) |
+[ObjectDependentSchemas](docs/components/schema/object_dependent_schemas.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_schemas.md

@@ -0,0 +1,12 @@
+# AnyTypeDependentSchemas
+json_schema_api.components.schema.any_type_dependent_schemas
+```
+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)