Read nullable property from anyOf types (#261)

Carapacik · Sep 29, 2024 · 7d357f4 · 7d357f4
1 parent 3a5b3f3
commit 7d357f4
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 3 deletions.
diff --git a/swagger_parser/lib/src/parser/parser/open_api_parser.dart b/swagger_parser/lib/src/parser/parser/open_api_parser.dart
@@ -679,7 +679,20 @@ class OpenApiParser {
         final propertyValue = props[propertyName] as Map<String, dynamic>;
         final nullablePropertyValue =
             propertyValue[_nullableConst].toString().toBool();
-        final isNullable = nullablePropertyValue ?? false;
+
+        final isNullable = nullablePropertyValue ??
+            switch (propertyValue) {
+              {_anyOfConst: final List<dynamic> anyOf} => anyOf.any(
+                  (e) => e is Map<String, dynamic> && e['type'] == 'null',
+                ),
+              {_oneOfConst: final List<dynamic> oneOf} => oneOf.any(
+                  (e) => e is Map<String, dynamic> && e['type'] == 'null',
+                ),
+              {_allOfConst: final List<dynamic> allOf} => allOf.any(
+                  (e) => e is Map<String, dynamic> && e['type'] == 'null',
+                ),
+              _ => false,
+            };
 
         final isRequired = requiredParameters.contains(propertyName);
         final typeWithImport = _findType(

diff --git a/...r_parser/test/e2e/tests/basic/of_like_class.3.1/expected_files/models/one_of_element.dart b/...r_parser/test/e2e/tests/basic/of_like_class.3.1/expected_files/models/one_of_element.dart
@@ -16,10 +16,11 @@ class OneOfElement with _$OneOfElement {
     required EnumClass oneClass,
     required int allType,
     required DateTime anyType,
-    required EnumClass? nullableClass,
+    required EnumClass? nullableButRequiredClass,
+    @Default([]) List<EnumClass>? nullableType,
+    EnumClass? nullableClass,
     @Default(EnumClass.value1) EnumClass anyClass,
     @Default([]) List<EnumClass> oneType,
-    @Default([]) List<EnumClass>? nullableType,
   }) = _OneOfElement;
 
   factory OneOfElement.fromJson(Map<String, Object?> json) =>

diff --git a/swagger_parser/test/e2e/tests/basic/of_like_class.3.1/of_like_class.3.1.json b/swagger_parser/test/e2e/tests/basic/of_like_class.3.1/of_like_class.3.1.json
@@ -5,6 +5,7 @@
     "schemas": {
       "OneOfElement": {
         "type": "object",
+        "required": ["nullableButRequiredClass"],
         "properties": {
           "allClass": {
             "allOf": [
@@ -54,6 +55,16 @@
             ],
             "default": "[]"
           },
+          "nullableButRequiredClass": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/EnumClass"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "nullableClass": {
             "anyOf": [
               {

diff --git a/...parser/test/e2e/tests/nullable_types/expected_files/models/class_with_nullable_types.dart b/...parser/test/e2e/tests/nullable_types/expected_files/models/class_with_nullable_types.dart
@@ -26,6 +26,8 @@ class ClassWithNullableTypes with _$ClassWithNullableTypes {
     @JsonKey(name: 'p1_list') required String? p1List,
     @JsonKey(name: 'p2_list') required List<String?>? p2List,
     @JsonKey(name: 'p3_list') required Object1? p3List,
+    @JsonKey(name: 'nonNull_anyOf') required dynamic nonNullAnyOf,
+    @JsonKey(name: 'required_null_anyOf') required String? requiredNullAnyOf,
     @JsonKey(name: 'p1_anyOf') required String? p1AnyOf,
     @JsonKey(name: 'p2_anyOf') required List<String?>? p2AnyOf,
     @JsonKey(name: 'p3_anyOf') required Object2? p3AnyOf,
@@ -38,6 +40,7 @@ class ClassWithNullableTypes with _$ClassWithNullableTypes {
     @JsonKey(name: 'p1_n') String? p1N,
     @JsonKey(name: 'p2_n') List<String?>? p2N,
     @JsonKey(name: 'p3_n') P3n? p3N,
+    @JsonKey(name: 'optional_null_anyOf') String? optionalNullAnyOf,
   }) = _ClassWithNullableTypes;
 
   factory ClassWithNullableTypes.fromJson(Map<String, Object?> json) =>

diff --git a/swagger_parser/test/e2e/tests/nullable_types/openapi.yaml b/swagger_parser/test/e2e/tests/nullable_types/openapi.yaml
@@ -70,6 +70,16 @@ components:
         - p2_null_item
         - p2_null_all
         - p3
+        - required_null_anyOf
+        - p1_anyOf
+        - p2_anyOf
+        - p3_anyOf
+        - p1_oneOf
+        - p2_oneOf
+        - p3_oneOf
+        - p1_allOf
+        - p2_allOf
+        - p3_allOf
       properties:
         p1:
           type: string
@@ -168,6 +178,19 @@ components:
                   - string
                   - null
 
+        nonNull_anyOf:
+          anyOf:
+            - type: string
+            - type: int
+        optional_null_anyOf:
+          anyOf:
+            - type: string
+            - type: null
+        required_null_anyOf:
+          anyOf:
+            - type: string
+            - type: null
+
         p1_anyOf:
           anyOf:
             - type: string
@@ -253,6 +276,9 @@ components:
           allOf:
             - type: object
             - type: null
+          required:
+            - p1
+            - p2
           properties:
             p1:
               allOf: