Adds prefixItems validation (#222)

* Adds java code to store prefixItems in codegenSchema

* Adds two sample component schemas with prefixItems

* Adds prefix_items data store in python schema class

* Adds validate_prefix_items

* Samples and docs regen

* Samples and docs updated

Author: spacether

docs/generators/java.md

@@ -343,6 +343,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |OneOf|✗|OAS3
 |Pattern|✓|OAS2,OAS3
 |PatternProperties|✗|OAS3
+|PrefixItems|✗|OAS3
 |Properties|✓|OAS2,OAS3
 |PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3

docs/generators/jaxrs-jersey.md

@@ -326,6 +326,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |OneOf|✗|OAS3
 |Pattern|✓|OAS2,OAS3
 |PatternProperties|✗|OAS3
+|PrefixItems|✗|OAS3
 |Properties|✓|OAS2,OAS3
 |PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3

docs/generators/jmeter.md

@@ -185,6 +185,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |OneOf|✗|OAS3
 |Pattern|✓|OAS2,OAS3
 |PatternProperties|✗|OAS3
+|PrefixItems|✗|OAS3
 |Properties|✓|OAS2,OAS3
 |PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3

docs/generators/kotlin.md

@@ -295,6 +295,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |OneOf|✗|OAS3
 |Pattern|✓|OAS2,OAS3
 |PatternProperties|✗|OAS3
+|PrefixItems|✗|OAS3
 |Properties|✓|OAS2,OAS3
 |PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3

docs/generators/python.md

@@ -254,6 +254,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |OneOf|✓|OAS3
 |Pattern|✓|OAS2,OAS3
 |PatternProperties|✓|OAS3
+|PrefixItems|✓|OAS3
 |Properties|✓|OAS2,OAS3
 |PropertyNames|✓|OAS3
 |Required|✓|OAS2,OAS3

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

@@ -41,6 +41,8 @@
     'not_': 'not',
     'one_of': 'oneOf',
     'pattern': 'pattern',
+    'pattern_properties': 'patternProperties',
+    'prefix_items': 'prefixItems',
     'properties': 'properties',
     'property_names': 'propertyNames',
     'required': 'required',

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

@@ -101,12 +101,20 @@ def _validate(
         if 'contains' in vars(cls_schema):
             contains_qty = _get_contains_qty(
                 arg,
-                json_schema_data['contains'],
+                vars(cls_schema)['contains'],
                 validation_metadata,
                 path_to_schemas
             )
+        prefix_items_length = 0
+        if 'prefix_items' in vars(cls_schema):
+            prefix_items_length = len(vars(cls_schema)['prefix_items'])
         for keyword, val in json_schema_data.items():
-            used_val = (val, contains_qty) if keyword in {'contains', 'min_contains', 'max_contains'} else val
+            if keyword in {'contains', 'min_contains', 'max_contains'}:
+                used_val = (val, contains_qty)
+            elif keyword == 'items':
+                used_val = (val, prefix_items_length)
+            else:
+                used_val = val
             validator = json_schema_keyword_to_validator[keyword]
 
             other_path_to_schemas = validator(
@@ -660,15 +668,17 @@ def validate_required(
 
 def validate_items(
     arg: typing.Any,
-    item_cls: typing.Type[SchemaValidator],
+    item_cls_prefix_items_length: typing.Tuple[typing.Type[SchemaValidator], int],
     cls: typing.Type,
     validation_metadata: ValidationMetadata,
 ) -> typing.Optional[PathToSchemasType]:
     if not isinstance(arg, tuple):
         return None
-    item_cls = _get_class(item_cls)
+    item_cls = _get_class(item_cls_prefix_items_length[0])
+    prefix_items_length = item_cls_prefix_items_length[1]
     path_to_schemas: PathToSchemasType = {}
-    for i, value in enumerate(arg):
+    for i in range(prefix_items_length, len(arg)):
+        value = arg[i]
         item_validation_metadata = ValidationMetadata(
             path_to_item=validation_metadata.path_to_item+(i,),
             configuration=validation_metadata.configuration,
@@ -1154,6 +1164,34 @@ def validate_pattern_properties(
     return path_to_schemas
 
 
+def validate_prefix_items(
+    arg: typing.Any,
+    prefix_items: typing.Tuple[typing.Type[SchemaValidator], ...],
+    cls: typing.Type,
+    validation_metadata: ValidationMetadata,
+) -> typing.Optional[PathToSchemasType]:
+    if not isinstance(arg, tuple):
+        return None
+    path_to_schemas: PathToSchemasType = {}
+    module_namespace = vars(sys.modules[cls.__module__])
+    for i, val in enumerate(arg):
+        if i >= len(prefix_items):
+            break
+        schema = _get_class(prefix_items[i], module_namespace)
+        path_to_item = validation_metadata.path_to_item + (i,)
+        item_validation_metadata = ValidationMetadata(
+            path_to_item=path_to_item,
+            configuration=validation_metadata.configuration,
+            validated_path_to_schemas=validation_metadata.validated_path_to_schemas
+        )
+        if item_validation_metadata.validation_ran_earlier(schema):
+            add_deeper_validated_schemas(validation_metadata, path_to_schemas)
+            continue
+        other_path_to_schemas = schema._validate(val, validation_metadata=item_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,
@@ -1188,5 +1226,6 @@ def validate_pattern_properties(
     'dependent_required': validate_dependent_required,
     'dependent_schemas': validate_dependent_schemas,
     'property_names': validate_property_names,
-    'pattern_properties': validate_pattern_properties
+    'pattern_properties': validate_pattern_properties,
+    'prefix_items': validate_prefix_items
 }

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

@@ -10,10 +10,12 @@ 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/any_type_pattern_properties.md
+docs/components/schema/any_type_prefix_items.md
 docs/components/schema/any_type_property_names.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/array_prefix_items.md
 docs/components/schema/object_dependent_required.md
 docs/components/schema/object_dependent_schemas.md
 docs/components/schema/object_pattern_properties.md
@@ -46,10 +48,12 @@ 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/any_type_pattern_properties.py
+src/json_schema_api/components/schema/any_type_prefix_items.py
 src/json_schema_api/components/schema/any_type_property_names.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/array_prefix_items.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/object_pattern_properties.py

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

@@ -180,10 +180,12 @@ Class | Description
 [AnyTypeMaxContainsValue](docs/components/schema/any_type_max_contains_value.md) |
 [AnyTypeMinContainsValue](docs/components/schema/any_type_min_contains_value.md) |
 [AnyTypePatternProperties](docs/components/schema/any_type_pattern_properties.md) |
+[AnyTypePrefixItems](docs/components/schema/any_type_prefix_items.md) |
 [AnyTypePropertyNames](docs/components/schema/any_type_property_names.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) |
+[ArrayPrefixItems](docs/components/schema/array_prefix_items.md) |
 [ObjectDependentRequired](docs/components/schema/object_dependent_required.md) |
 [ObjectDependentSchemas](docs/components/schema/object_dependent_schemas.md) |
 [ObjectPatternProperties](docs/components/schema/object_pattern_properties.md) |

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

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