Adds example schema with optional props only and addProps false

Author: spacether

modules/openapi-json-schema-generator/src/main/java/org/openapijsonschematools/codegen/DefaultCodegen.java

@@ -2294,7 +2294,7 @@ public CodegenSchema fromSchema(Schema p, String sourceJsonPath, String currentJ
         if (currentJsonPath != null) {
             String currentName = currentJsonPath.substring(currentJsonPath.lastIndexOf("/") + 1);
             property.requiredProperties = getRequiredProperties(required, property.properties, property.additionalProperties, requiredAndOptionalProperties, sourceJsonPath, ((Schema<?>) p).getProperties(), currentName);
-            property.optionalProperties = getOptionalProperties(property.properties, required, sourceJsonPath, currentName);
+            property.optionalProperties = getOptionalProperties(property.properties, required, sourceJsonPath, currentName, property.additionalProperties);
             if ((property.types == null || property.types.contains("object")) && sourceJsonPath != null) {
                 boolean addPropsIsFalse = property.additionalProperties != null && property.additionalProperties.isBooleanSchemaFalse;
                 // only set mapInputJsonPathPiece when object input is possible
@@ -3334,7 +3334,7 @@ protected LinkedHashMapWithContext<CodegenKey, CodegenSchema> getProperties(Map<
      * @param required  a set of required properties' name
      * @return the optional properties
      */
-    protected LinkedHashMapWithContext<CodegenKey, CodegenSchema> getOptionalProperties(LinkedHashMapWithContext<CodegenKey, CodegenSchema> properties, Set<String> required, String sourceJsonPath, String currentName) {
+    protected LinkedHashMapWithContext<CodegenKey, CodegenSchema> getOptionalProperties(LinkedHashMapWithContext<CodegenKey, CodegenSchema> properties, Set<String> required, String sourceJsonPath, String currentName, CodegenSchema additionalProperties) {
         if (properties == null) {
             return null;
         }
@@ -3343,7 +3343,13 @@ protected LinkedHashMapWithContext<CodegenKey, CodegenSchema> getOptionalPropert
             LinkedHashMapWithContext<CodegenKey, CodegenSchema> optionalProperties = new LinkedHashMapWithContext<>();
             optionalProperties.putAll(properties);
             optionalProperties.setAllAreInline(properties.allAreInline());
-            CodegenKey jsonPathPiece = getKey(currentName + "DictInput", "schemaProperty", sourceJsonPath);
+            CodegenKey jsonPathPiece;
+            boolean addPropsIsFalse = additionalProperties != null && additionalProperties.isBooleanSchemaFalse;
+            if (addPropsIsFalse) {
+                jsonPathPiece = getKey(currentName + "Dict", "schemaProperty", sourceJsonPath);
+            } else {
+                jsonPathPiece = getKey(currentName + "DictInput", "schemaProperty", sourceJsonPath);
+            }
             optionalProperties.setJsonPathPiece(jsonPathPiece);
             return optionalProperties;
         }

modules/openapi-json-schema-generator/src/test/resources/3_0/python/petstore_customized.yaml

@@ -3080,6 +3080,7 @@ components:
       required:
         - amount
         - currency
+      additionalProperties: false
     DecimalPayload:
       type: string
       format: number
@@ -3289,4 +3290,11 @@ components:
       required:
         - a
       allOf:
-        - $ref: '#/components/schemas/ObjWithRequiredPropsBase'
+        - $ref: '#/components/schemas/ObjWithRequiredPropsBase'
+    ObjectWithOnlyOptionalProps:
+      properties:
+        a:
+          type: string
+        b:
+          type: number
+      additionalProperties: false

samples/openapi3/client/petstore/python/.openapi-generator/FILES

@@ -128,6 +128,7 @@ docs/components/schema/object_with_decimal_properties.md
 docs/components/schema/object_with_difficultly_named_props.md
 docs/components/schema/object_with_inline_composition_property.md
 docs/components/schema/object_with_invalid_named_refed_properties.md
+docs/components/schema/object_with_only_optional_props.md
 docs/components/schema/object_with_optional_test_prop.md
 docs/components/schema/object_with_validations.md
 docs/components/schema/order.md
@@ -476,6 +477,7 @@ src/petstore_api/components/schema/object_with_decimal_properties.py
 src/petstore_api/components/schema/object_with_difficultly_named_props.py
 src/petstore_api/components/schema/object_with_inline_composition_property.py
 src/petstore_api/components/schema/object_with_invalid_named_refed_properties.py
+src/petstore_api/components/schema/object_with_only_optional_props.py
 src/petstore_api/components/schema/object_with_optional_test_prop.py
 src/petstore_api/components/schema/object_with_validations.py
 src/petstore_api/components/schema/order.py

samples/openapi3/client/petstore/python/README.md

@@ -363,6 +363,7 @@ Class | Description
 [ObjectWithDifficultlyNamedProps](docs/components/schema/object_with_difficultly_named_props.md) | model with properties that have invalid names for python
 [ObjectWithInlineCompositionProperty](docs/components/schema/object_with_inline_composition_property.md) |
 [ObjectWithInvalidNamedRefedProperties](docs/components/schema/object_with_invalid_named_refed_properties.md) |
+[ObjectWithOnlyOptionalProps](docs/components/schema/object_with_only_optional_props.md) |
 [ObjectWithOptionalTestProp](docs/components/schema/object_with_optional_test_prop.md) |
 [ObjectWithValidations](docs/components/schema/object_with_validations.md) |
 [Order](docs/components/schema/order.md) |

samples/openapi3/client/petstore/python/docs/components/schema/money.md

@@ -11,6 +11,5 @@ Key | Input Type | Accessed Type | Description | Notes
 ------------ | ------------- | ------------- | ------------- | -------------
 **amount** | str | str |  | value must be numeric and storable in decimal.Decimal
 **currency** | [**Currency**](currency.md), str | [**Currency**](currency.md) |  |
-**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)

samples/openapi3/client/petstore/python/docs/components/schema/object_with_only_optional_props.md

@@ -0,0 +1,15 @@
+petstore_api.components.schema.object_with_only_optional_props
+# Schema ObjectWithOnlyOptionalProps
+
+## Type Info
+Input Type | Accessed Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+dict, frozendict.frozendict | frozendict.frozendict |  |
+
+## Dictionary Keys
+Key | Input Type | Accessed Type | Description | Notes
+------------ | ------------- | ------------- | ------------- | -------------
+**a** | str | str |  | [optional]
+**b** | decimal.Decimal, int, float | decimal.Decimal |  | [optional]
+
+[[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/money.py

@@ -10,6 +10,7 @@
 from __future__ import annotations
 from petstore_api.shared_imports.schema_imports import *
 
+AdditionalProperties: typing_extensions.TypeAlias = schemas.NotAnyTypeSchema[U]
 Amount: typing_extensions.TypeAlias = schemas.DecimalSchema[U]
 
 
@@ -31,6 +32,7 @@ class Schema_(metaclass=schemas.SingletonMeta):
             "currency",
         })
         properties: Properties = dataclasses.field(default_factory=lambda: schemas.typed_dict_to_instance(Properties)) # type: ignore
+        additional_properties: typing.Type[AdditionalProperties] = dataclasses.field(default_factory=lambda: AdditionalProperties) # type: ignore
 
     @property
     def amount(self) -> Amount[str]:
@@ -46,24 +48,11 @@ def __getitem__(self, name: typing_extensions.Literal["amount"]) -> Amount[str]:
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["currency"]) -> currency.Currency[str]: ...
 
-    @typing.overload
-    def __getitem__(self, name: str) -> schemas.AnyTypeSchema[typing.Union[
-        frozendict.frozendict,
-        str,
-        decimal.Decimal,
-        schemas.BoolClass,
-        schemas.NoneClass,
-        tuple,
-        bytes,
-        schemas.FileIO
-    ]]: ...
-    
     def __getitem__(
         self,
         name: typing.Union[
             typing_extensions.Literal["amount"],
             typing_extensions.Literal["currency"],
-            str
         ]
     ):
         # dict_instance[name] accessor
@@ -73,7 +62,7 @@ def __getitem__(
     def validate(
         cls,
         arg: typing.Union[
-            MoneyDictInput,
+            MoneyDict,
             Money[frozendict.frozendict],
         ],
         configuration: typing.Optional[schemas.schema_configuration.SchemaConfiguration] = None
@@ -92,57 +81,16 @@ def validate(
         "currency": typing.Type[currency.Currency],
     }
 )
-MoneyDictInput = typing.Mapping[
-    str,
-    typing.Union[
-        typing.Union[
+MoneyDict = typing_extensions.TypedDict(
+    'MoneyDict',
+    {
+        "amount": typing.Union[
             Amount[str],
             str
         ],
-        typing.Union[
+        "currency": typing.Union[
             currency.Currency[str],
             str
         ],
-        schemas.INPUT_TYPES_ALL_INCL_SCHEMA
-    ]
-]
-
-
-class MoneyDict(typing.Dict[str, typing.Any]):
-    
-    @property
-    def amount(self) -> Amount[str]:
-        return self.__getitem__("amount")
-    
-    @property
-    def currency(self) -> currency.Currency[str]:
-        return self.__getitem__("currency")
-    
-    @typing.overload
-    def __getitem__(self, name: typing_extensions.Literal["amount"]) -> Amount[str]: ...
-    
-    @typing.overload
-    def __getitem__(self, name: typing_extensions.Literal["currency"]) -> currency.Currency[str]: ...
-    
-    @typing.overload
-    def __getitem__(self, name: str) -> schemas.AnyTypeSchema[typing.Union[
-        frozendict.frozendict,
-        str,
-        decimal.Decimal,
-        schemas.BoolClass,
-        schemas.NoneClass,
-        tuple,
-        bytes,
-        schemas.FileIO
-    ]]: ...
-    
-    def __getitem__(
-        self,
-        name: typing.Union[
-            typing_extensions.Literal["amount"],
-            typing_extensions.Literal["currency"],
-            str
-        ]
-    ):
-        # dict_instance[name] accessor
-        return super().__getitem__(name)
+    }
+)

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/object_with_only_optional_props.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  # noqa: E501
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://github.com/openapi-json-schema-tools/openapi-json-schema-generator
+"""
+
+from __future__ import annotations
+from petstore_api.shared_imports.schema_imports import *
+
+AdditionalProperties: typing_extensions.TypeAlias = schemas.NotAnyTypeSchema[U]
+A: typing_extensions.TypeAlias = schemas.StrSchema[U]
+B: typing_extensions.TypeAlias = schemas.NumberSchema[U]
+Properties = typing_extensions.TypedDict(
+    'Properties',
+    {
+        "a": typing.Type[A],
+        "b": typing.Type[B],
+    }
+)
+ObjectWithOnlyOptionalPropsDict = typing_extensions.TypedDict(
+    'ObjectWithOnlyOptionalPropsDict',
+    {
+        "a": typing.Union[
+            A[str],
+            str
+        ],
+        "b": typing.Union[
+            B[decimal.Decimal],
+            decimal.Decimal,
+            int,
+            float
+        ],
+    },
+    total=False
+)
+
+
+class ObjectWithOnlyOptionalProps(
+    schemas.DictSchema[schemas.T]
+):
+    """NOTE: This class is auto generated by OpenAPI JSON Schema Generator.
+    Ref: https://github.com/openapi-json-schema-tools/openapi-json-schema-generator
+
+    Do not edit the class manually.
+    """
+
+
+    @dataclasses.dataclass(frozen=True)
+    class Schema_(metaclass=schemas.SingletonMeta):
+        types: typing.FrozenSet[typing.Type] = frozenset({frozendict.frozendict})
+        properties: Properties = dataclasses.field(default_factory=lambda: schemas.typed_dict_to_instance(Properties)) # type: ignore
+        additional_properties: typing.Type[AdditionalProperties] = dataclasses.field(default_factory=lambda: AdditionalProperties) # type: ignore
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["a"]) -> A[str]: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["b"]) -> B[decimal.Decimal]: ...
+    
+    def __getitem__(
+        self,
+        name: typing.Union[
+            typing_extensions.Literal["a"],
+            typing_extensions.Literal["b"],
+        ]
+    ):
+        # dict_instance[name] accessor
+        return super().__getitem__(name)
+
+    @classmethod
+    def validate(
+        cls,
+        arg: typing.Union[
+            ObjectWithOnlyOptionalPropsDict,
+            ObjectWithOnlyOptionalProps[frozendict.frozendict],
+        ],
+        configuration: typing.Optional[schemas.schema_configuration.SchemaConfiguration] = None
+    ) -> ObjectWithOnlyOptionalPropsDict:
+        return super().validate(
+            arg,
+            configuration=configuration,
+        )
+

samples/openapi3/client/petstore/python/src/petstore_api/components/schemas/__init__.py

@@ -100,6 +100,7 @@
 from petstore_api.components.schema.object_with_difficultly_named_props import ObjectWithDifficultlyNamedProps
 from petstore_api.components.schema.object_with_inline_composition_property import ObjectWithInlineCompositionProperty
 from petstore_api.components.schema.object_with_invalid_named_refed_properties import ObjectWithInvalidNamedRefedProperties
+from petstore_api.components.schema.object_with_only_optional_props import ObjectWithOnlyOptionalProps
 from petstore_api.components.schema.object_with_optional_test_prop import ObjectWithOptionalTestProp
 from petstore_api.components.schema.object_with_validations import ObjectWithValidations
 from petstore_api.components.schema.order import Order

samples/openapi3/client/petstore/python/test/components/schema/test_object_with_only_optional_props.py

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  # noqa: E501
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://github.com/openapi-json-schema-tools/openapi-json-schema-generator
+"""
+
+import unittest
+
+import petstore_api
+from petstore_api.components.schema.object_with_only_optional_props import ObjectWithOnlyOptionalProps
+from petstore_api.configurations import schema_configuration
+
+
+class TestObjectWithOnlyOptionalProps(unittest.TestCase):
+    """ObjectWithOnlyOptionalProps unit test stubs"""
+    configuration = schema_configuration.SchemaConfiguration()
+
+
+if __name__ == '__main__':
+    unittest.main()