Adds 3.1.0 json schema propertyNames (#216)

* Adds two propertyNames component schema examples

* Adds validator and supressable keyword for propertyNames

* Adds python test samples

* Regenerates samples and docs

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
 |Properties|✓|OAS2,OAS3
+|PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3
 |Type|✓|OAS2,OAS3
 |UniqueItems|✓|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
 |Properties|✓|OAS2,OAS3
+|PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3
 |Type|✓|OAS2,OAS3
 |UniqueItems|✓|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
 |Properties|✓|OAS2,OAS3
+|PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3
 |Type|✓|OAS2,OAS3
 |UniqueItems|✓|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
 |Properties|✓|OAS2,OAS3
+|PropertyNames|✗|OAS3
 |Required|✓|OAS2,OAS3
 |Type|✓|OAS2,OAS3
 |UniqueItems|✓|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
 |Properties|✓|OAS2,OAS3
+|PropertyNames|✓|OAS3
 |Required|✓|OAS2,OAS3
 |Type|✓|OAS2,OAS3
 |UniqueItems|✓|OAS2,OAS3

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

@@ -42,6 +42,7 @@
     'one_of': 'oneOf',
     'pattern': 'pattern',
     'properties': 'properties',
+    'property_names': 'propertyNames',
     'required': 'required',
     'types': 'type',
     'unique_items': 'uniqueItems'

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

@@ -1103,6 +1103,27 @@ def validate_dependent_schemas(
     return path_to_schemas
 
 
+def validate_property_names(
+    arg: typing.Any,
+    property_names_schema: typing.Type[SchemaValidator],
+    cls: typing.Type,
+    validation_metadata: ValidationMetadata,
+) -> None:
+    if not isinstance(arg, immutabledict):
+        return None
+    module_namespace = vars(sys.modules[cls.__module__])
+    property_names_schema = _get_class(property_names_schema, module_namespace)
+    for key in arg.keys():
+        path_to_item = validation_metadata.path_to_item + (key,)
+        key_validation_metadata = ValidationMetadata(
+            path_to_item=path_to_item,
+            configuration=validation_metadata.configuration,
+            validated_path_to_schemas=validation_metadata.validated_path_to_schemas
+        )
+        property_names_schema._validate(key, validation_metadata=key_validation_metadata)
+    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,
@@ -1135,5 +1156,6 @@ def validate_dependent_schemas(
     'max_contains': validate_max_contains,
     'const_value_to_name': validate_const,
     'dependent_required': validate_dependent_required,
-    'dependent_schemas': validate_dependent_schemas
+    'dependent_schemas': validate_dependent_schemas,
+    'property_names': validate_property_names
 }

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

@@ -9,11 +9,13 @@ 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/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/object_dependent_required.md
 docs/components/schema/object_dependent_schemas.md
+docs/components/schema/object_property_names.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
@@ -41,11 +43,13 @@ 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/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/object_dependent_required.py
 src/json_schema_api/components/schema/object_dependent_schemas.py
+src/json_schema_api/components/schema/object_property_names.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

@@ -179,11 +179,13 @@ Class | Description
 [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) |
+[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) |
 [ObjectDependentRequired](docs/components/schema/object_dependent_required.md) |
 [ObjectDependentSchemas](docs/components/schema/object_dependent_schemas.md) |
+[ObjectPropertyNames](docs/components/schema/object_property_names.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_property_names.md

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