Adds 3.1.0 contains feature (#205)

* Adds sample that contains contains schemas

* Adds writes contains data in codegenschema

* Writes schema class if it has contains info

* Writes contains info in schema_cls

* Writes contains schemas for anyType and array type

* Adds contains validator

* Sample regen

* Adds sample testing 310 contains

* Docs regen

Author: spacether

.circleci/parallel.sh

@@ -23,6 +23,7 @@ elif [ "$JOB_ID" = "testPythonClientSamples" ]; then
   (cd samples/client/3_0_3_unit_test/python && make test)
   (cd samples/client/openapi_features/nonCompliantUseDiscriminatorIfCompositionFails/python && make test)
   (cd samples/client/openapi_features/security/python && make test)
+  (cd samples/client/3_1_0_json_schema/python && make test)
 
 else
   echo "Running job $JOB_ID"

bin/generate_samples_configs/python_3_1_0_json_schema.yaml

@@ -0,0 +1,5 @@
+generatorName: python
+outputDir: samples/client/3_1_0_json_schema/python
+inputSpec: src/test/resources/3_1/json_schema.yaml
+additionalProperties:
+  packageName: json_schema_api

docs/generators/java.md

@@ -316,6 +316,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3

docs/generators/jaxrs-jersey.md

@@ -299,6 +299,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3

docs/generators/jmeter.md

@@ -158,6 +158,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3

docs/generators/kotlin.md

@@ -268,6 +268,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3

docs/generators/python.md

@@ -227,6 +227,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✓|OAS2,OAS3
 |AllOf|✓|OAS2,OAS3
 |AnyOf|✓|OAS3
+|Contains|✓|OAS3
 |Default|✓|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3
 |Enum|✓|OAS2,OAS3

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

@@ -66,7 +66,7 @@ def __init__(
         """Constructor
         """
         # Authentication Settings
-        self.security_scheme_info = {}
+        self.security_scheme_info: typing.Dict[str, typing.Any] = {}
         self.security_index_info = {'security': 0}
         # Server Info
         self.server_info: ServerInfo = server_info or {

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

@@ -16,6 +16,7 @@
     'additional_properties': 'additionalProperties',
     'all_of': 'allOf',
     'any_of': 'anyOf',
+    'contains': 'contains',
     '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

@@ -956,6 +956,41 @@ def validate_discriminator(
     return discriminated_cls._validate(arg, validation_metadata=updated_vm)
 
 
+def validate_contains(
+    arg: typing.Any,
+    contains_cls: typing.Type[SchemaValidator],
+    cls: typing.Type,
+    validation_metadata: ValidationMetadata,
+) -> typing.Optional[PathToSchemasType]:
+    if not isinstance(arg, tuple):
+        return None
+    contains_cls = _get_class(contains_cls)
+    path_to_schemas: PathToSchemasType = {}
+    array_contains_item = False
+    for i, value in enumerate(arg):
+        item_validation_metadata = ValidationMetadata(
+            path_to_item=validation_metadata.path_to_item+(i,),
+            configuration=validation_metadata.configuration,
+            validated_path_to_schemas=validation_metadata.validated_path_to_schemas
+        )
+        if item_validation_metadata.validation_ran_earlier(contains_cls):
+            add_deeper_validated_schemas(item_validation_metadata, path_to_schemas)
+            return path_to_schemas
+        try:
+            other_path_to_schemas = contains_cls._validate(
+                value, validation_metadata=item_validation_metadata)
+            update(path_to_schemas, other_path_to_schemas)
+            return path_to_schemas
+        except exceptions.OpenApiException:
+            pass
+    if not array_contains_item:
+        raise exceptions.ApiValueError(
+            "Validation failed for contains keyword in class={} at path_to_item={}. No "
+            "items validated to the contains schema.".format(cls, validation_metadata.path_to_item)
+        )
+    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,
@@ -982,5 +1017,6 @@ def validate_discriminator(
     'any_of': validate_any_of,
     'all_of': validate_all_of,
     'not_': validate_not,
-    'discriminator': validate_discriminator
+    'discriminator': validate_discriminator,
+    'contains': validate_contains
 }