Support optional key (#329)

Author: koji-1009

swagger_parser/lib/src/parser/parser/open_api_parser.dart

@@ -676,8 +676,16 @@ class OpenApiParser {
     final imports = <String>{};
 
     var requiredParameters = <String>[];
+    var hasAllOfKey = false;
     if (map case {_requiredConst: final List<dynamic> rawParameters}) {
       requiredParameters = rawParameters.map((e) => e.toString()).toList();
+    } else if (map case {_propertiesConst: final Map<String, dynamic> props}) {
+      for (final propertyName in props.keys) {
+        final propertyValue = props[propertyName] as Map<String, dynamic>;
+        if (propertyValue.containsKey(_allOfConst)) {
+          hasAllOfKey = true;
+        }
+      }
     }
 
     if (map case {_propertiesConst: final Map<String, dynamic> props}) {
@@ -687,6 +695,7 @@ class OpenApiParser {
         // OpenAPI 2.0 nullable value
         isNullable =
             isNullable ?? propertyValue[_xNullableConst].toString().toBool();
+        final hasDefaultKey = propertyValue.containsKey(_defaultConst);
 
         isNullable = isNullable ??
             switch (propertyValue) {
@@ -709,7 +718,7 @@ class OpenApiParser {
           additionalName: additionalName,
           isRequired: (_apiInfo.schemaVersion == OAS.v2 && !config.useXNullable)
               ? isRequired
-              : isRequired || !isNullable,
+              : isRequired || hasAllOfKey || hasDefaultKey,
         );
 
         var validation = propertyValue;

swagger_parser/test/e2e/e2e_test.dart

@@ -117,6 +117,19 @@ void main() {
         schemaFileName: 'swagger.yaml',
       );
     });
+
+    test('no_required_params', () async {
+      await e2eTest(
+        'no_required_params',
+        (outputDirectory, schemaPath) => SWPConfig(
+          outputDirectory: outputDirectory,
+          schemaPath: schemaPath,
+          jsonSerializer: JsonSerializer.freezed,
+          putClientsInFolder: true,
+        ),
+        schemaFileName: 'openapi.yaml',
+      );
+    });
   });
 
   group('basic', () {

swagger_parser/test/e2e/tests/basic/additional_properties_class.3.0/additional_properties_class.3.0.json

@@ -14,7 +14,10 @@
               "type": "object"
             }
           }
-        }
+        },
+        "required": [
+          "data"
+        ]
       },
       "ExampleParsable": {
         "type": "object",
@@ -27,7 +30,10 @@
               "$ref": "#/definitions/Example"
             }
           }
-        }
+        },
+        "required": [
+          "data"
+        ]
       }
     }
   }

swagger_parser/test/e2e/tests/basic/basic_requests.2.0/basic_requests.2.0.json

@@ -128,7 +128,12 @@
           "type": "string"
         }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "required": [
+        "email",
+        "name",
+        "password"
+      ]
     },
     "UserInfoDto": {
       "type": "object",
@@ -143,7 +148,12 @@
           "type": "string"
         }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "required": [
+        "email",
+        "name",
+        "phone"
+      ]
     }
   }
 }

swagger_parser/test/e2e/tests/basic/basic_requests.3.0/basic_requests.3.0.json

@@ -120,7 +120,12 @@
               "password": {
                 "type": "string"
               }
-            }
+            },
+            "required": [
+              "email",
+              "name",
+              "password"
+            ]
           }
         ]
       },
@@ -138,10 +143,15 @@
               "phone": {
                 "type": "string"
               }
-            }
+            },
+            "required": [
+              "email",
+              "name",
+              "phone"
+            ]
           }
         ]
       }
     }
   }
-}
+}

swagger_parser/test/e2e/tests/basic/basic_types_class.2.0/basic_types_class.2.0.json

@@ -64,7 +64,23 @@
             }
           }
         }
-      }
+      },
+      "required": [
+        "integer1",
+        "float1",
+        "double1",
+        "string1",
+        "number1",
+        "string2",
+        "string3",
+        "string4",
+        "string5",
+        "file1",
+        "bool1",
+        "object1",
+        "array1",
+        "array2"
+      ]
     }
   }
 }

swagger_parser/test/e2e/tests/basic/basic_types_class.3.0/basic_types_class.3.0.json

@@ -73,8 +73,25 @@
             "type": "array",
             "default": []
           }
-        }
+        },
+        "required": [
+          "integer1",
+          "float1",
+          "double1",
+          "string1",
+          "number1",
+          "string2",
+          "string3",
+          "string4",
+          "string5",
+          "file1",
+          "bool1",
+          "object1",
+          "array1",
+          "array2",
+          "arrayWithDefault"
+        ]
       }
     }
   }
-}
+}

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0/discriminated_one_of.3.0.json

@@ -34,7 +34,10 @@
               }
             }
           }
-        }
+        },
+        "required": [
+          "members"
+        ]
       },
       "Cat": {
         "type": "object",

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/discriminated_one_of.3.0.json

@@ -34,7 +34,10 @@
               }
             }
           }
-        }
+        },
+        "required": [
+          "members"
+        ]
       },
       "Cat": {
         "type": "object",
@@ -140,4 +143,4 @@
       }
     }
   }
-}
+}

swagger_parser/test/e2e/tests/basic/enum_class/enum_class.json

@@ -21,8 +21,11 @@
             },
             "collectionFormat": "multi"
           }
-        }
+        },
+        "required": [
+          "status"
+        ]
       }
     }
   }
-}
+}