feat: required based on default value (#205)

Add setting to control required flag based on default value

Author: leedsalex

README.md

@@ -36,6 +36,7 @@ Alternatively, you can non-primitive types like BigInt to avoid this requirement
 Since the v2.7 releases, Scala 2 builds use scala-reflect jar to try to work out the class information for the inner types. Since v2.7.5, Scala 3 builds use a lib that supports runtime reflection. See https://github.com/swagger-akka-http/swagger-scala-module/issues/117. One issue affacting Scala 3 users is https://github.com/gzoller/scala-reflection/issues/40.
 
 v2.7 takes default values into account - either those specified in Scala contructors or via swagger annotations. A field might be marked as not required if a default value is specified.
+If you don't use swagger annotations, and would like not like to infer the `required` value based on the default value, then you can set `SwaggerScalaModelConverter.setRequiredBasedOnDefaultValue` to `false`
 
 If you use swagger annotations and don't want to explicity set the `required` value and allow this lib to infer the value, then you can set [SwaggerScalaModelConverter.setRequiredBasedOnAnnotation](https://github.com/swagger-akka-http/swagger-scala-module/blob/564c7c7fb879c1b93b7c913af2219dc4b550ad95/src/main/scala/com/github/swagger/scala/converter/SwaggerScalaModelConverter.scala#L39).
 

src/main/scala/com/github/swagger/scala/converter/SwaggerScalaModelConverter.scala

@@ -27,11 +27,12 @@ object SwaggerScalaModelConverter {
   val objectMapper: ObjectMapper = Json.mapper().registerModule(DefaultScalaModule)
 
   private var requiredBasedOnAnnotation = true
+  private var requiredBasedOnDefaultValue = true
 
   /** If you use swagger annotations to override what is automatically derived, then be aware that
     * [[io.swagger.v3.oas.annotations.media.Schema]] annotation has required = false, by default. You are advised to set the required
     * flag on this annotation to the correct value. If you would prefer to have the Schema annotation required flag ignored and to rely on
-    * the this module inferring the value (as ot would if you don't annotate the classes or fields), then set
+    * the this module inferring the value (as it would if you don't annotate the classes or fields), then set
     * [[SwaggerScalaModelConverter.setRequiredBasedOnAnnotation]] to true and the required property on the annotation will be ignored,
     * unless the field is an [[Option]].
     *
@@ -42,17 +43,41 @@ object SwaggerScalaModelConverter {
     requiredBasedOnAnnotation = value
   }
 
+  /** If you use swagger annotations to override what is automatically derived, then this flag will not be used.
+    * If you rely on this module inferring the required flag (as it would if you don't annotate the classes or fields),
+    * then this flag will control how the required flag is derived when a default value exists.
+    * If [[SwaggerScalaModelConverter.setRequiredBasedOnDefaultValue]] is true and a property has a default value, then it will not be required.
+    * However, if this flag is false, then a property will be required only if it's not an [[Option]].
+    *
+    * @param value
+    *   true by default
+    */
+  def setRequiredBasedOnDefaultValue(value: Boolean = true): Unit = {
+    requiredBasedOnDefaultValue = value
+  }
+
   /** If you use swagger annotations to override what is automatically derived, then be aware that
     * [[io.swagger.v3.oas.annotations.media.Schema]] annotation has required = false, by default. You are advised to set the required
     * flag on this annotation to the correct value. If you would prefer to have the Schema annotation required flag ignored and to rely on
-    * the this module inferring the value (as ot would if you don't annotate the classes or fields), then set
+    * the this module inferring the value (as it would if you don't annotate the classes or fields), then set
     * [[SwaggerScalaModelConverter.setRequiredBasedOnAnnotation]] to true and the required property on the annotation will be ignored,
     * unless the field is an [[Option]].
     *
     * @return
     *   value: true by default
     */
   def isRequiredBasedOnAnnotation: Boolean = requiredBasedOnAnnotation
+
+  /** If you use swagger annotations to override what is automatically derived, then this flag will not be used.
+    * If you rely on this module inferring the required flag (as it would if you don't annotate the classes or fields),
+    * then this flag will control how the required flag is derived when a default value exists.
+    * If [[SwaggerScalaModelConverter.setRequiredBasedOnDefaultValue]] is true and a property has a default value, then it will not be required.
+    * However, if this flag is false, then a property will be required only if it's not an [[Option]].
+    *
+    * @return
+    * value: true by default
+    */
+  def isRequiredBasedOnDefaultValue: Boolean = requiredBasedOnDefaultValue
 }
 
 class SwaggerScalaModelConverter extends ModelResolver(SwaggerScalaModelConverter.objectMapper) {
@@ -191,7 +216,7 @@ class SwaggerScalaModelConverter extends ModelResolver(SwaggerScalaModelConverte
           }
           propertyAnnotations match {
             case Seq() => {
-              val requiredFlag = !isOptional && !hasDefaultValue
+              val requiredFlag = !isOptional && (!SwaggerScalaModelConverter.isRequiredBasedOnDefaultValue || !hasDefaultValue)
               if (!requiredFlag && Option(schema.getRequired).isDefined && schema.getRequired.contains(propertyName)) {
                 schema.getRequired.remove(propertyName)
               } else if (requiredFlag) {
@@ -252,9 +277,9 @@ class SwaggerScalaModelConverter extends ModelResolver(SwaggerScalaModelConverte
   ): Unit = {
     val required = if (isOptional) {
       annotationSetting
-    } else {
+    } else if (SwaggerScalaModelConverter.isRequiredBasedOnDefaultValue) {
       !hasDefaultValue
-    }
+    } else true
     if (required) addRequiredItem(schema, propertyName)
   }
 

src/test/scala/com/github/swagger/scala/converter/ModelPropertyParserTest.scala

@@ -27,8 +27,9 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
     val converter = ModelConverters.getInstance()
   }
 
-  class PropertiesScope[A](requiredBasedAnnotation: Boolean = true, debug: Boolean = false)(implicit tt: ClassTag[A]) extends TestScope {
+  class PropertiesScope[A](requiredBasedAnnotation: Boolean = true, requiredBasedDefaultValue: Boolean = true, debug: Boolean = false)(implicit tt: ClassTag[A]) extends TestScope {
     SwaggerScalaModelConverter.setRequiredBasedOnAnnotation(requiredBasedAnnotation)
+    SwaggerScalaModelConverter.setRequiredBasedOnDefaultValue(requiredBasedDefaultValue)
     val schemas = converter.readAll(tt.runtimeClass).asScala.toMap
     val model = schemas.get(tt.runtimeClass.getSimpleName)
     model should be(defined)
@@ -158,7 +159,7 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
   }
 
   it should "prioritize required as specified in annotation by default" in new PropertiesScope[ModelWOptionIntSchemaOverrideForRequired](
-    true
+    true, true
   ) {
     val requiredIntWithDefault = model.value.getProperties.get("requiredIntWithDefault")
     requiredIntWithDefault shouldBe an[IntegerSchema]
@@ -183,9 +184,35 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
     nullSafeSeq(model.value.getRequired).toSet shouldEqual Set("annotatedOptionalInt", "requiredInt")
   }
 
+  it should "prioritize required as specified in annotation and not based on default value" in new PropertiesScope[ModelWOptionIntSchemaOverrideForRequired](
+    true, false
+  ) {
+    val requiredIntWithDefault = model.value.getProperties.get("requiredIntWithDefault")
+    requiredIntWithDefault shouldBe an[IntegerSchema]
+    requiredIntWithDefault.asInstanceOf[IntegerSchema].getDefault shouldEqual 5
+
+    val annotatedIntWithDefault = model.value.getProperties.get("annotatedIntWithDefault")
+    annotatedIntWithDefault shouldBe an[IntegerSchema]
+    annotatedIntWithDefault.asInstanceOf[IntegerSchema].getDefault shouldEqual 10
+
+    val annotatedOptionalIntWithNoneDefault = model.value.getProperties.get("annotatedOptionalIntWithNoneDefault")
+    annotatedOptionalIntWithNoneDefault shouldBe an[IntegerSchema]
+    annotatedOptionalIntWithNoneDefault.asInstanceOf[IntegerSchema].getDefault should be(null)
+
+    val annotatedOptionalIntWithSomeDefault = model.value.getProperties.get("annotatedOptionalIntWithSomeDefault")
+    annotatedOptionalIntWithSomeDefault shouldBe an[IntegerSchema]
+    annotatedOptionalIntWithSomeDefault.asInstanceOf[IntegerSchema].getDefault should be(5)
+
+    val annotatedOptionalStringWithNoneDefault = model.value.getProperties.get("annotatedOptionalStringWithNoneDefault")
+    annotatedOptionalStringWithNoneDefault shouldBe an[StringSchema]
+    annotatedOptionalStringWithNoneDefault.asInstanceOf[StringSchema].getDefault should be(null)
+
+    nullSafeSeq(model.value.getRequired).toSet shouldEqual Set("annotatedOptionalInt", "requiredInt", "requiredIntWithDefault")
+  }
+
   it should "prioritize required based on (Option or not) type when `setRequiredBasedOnAnnotation` is set" in new PropertiesScope[
     ModelWOptionIntSchemaOverrideForRequired
-  ](requiredBasedAnnotation = false) {
+  ](requiredBasedAnnotation = false, requiredBasedDefaultValue = true) {
 
     val requiredIntWithDefault = model.value.getProperties.get("requiredIntWithDefault")
     requiredIntWithDefault shouldBe an[IntegerSchema]
@@ -210,6 +237,33 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
     nullSafeSeq(model.value.getRequired).toSet shouldEqual Set("annotatedOptionalInt", "requiredInt", "annotatedRequiredInt")
   }
 
+  it should "prioritize required based on (Option or not) type when `setRequiredBasedOnAnnotation` and `requiredBasedDefaultValue` is set" in new PropertiesScope[
+    ModelWOptionIntSchemaOverrideForRequired
+  ](requiredBasedAnnotation = false, requiredBasedDefaultValue = false) {
+
+    val requiredIntWithDefault = model.value.getProperties.get("requiredIntWithDefault")
+    requiredIntWithDefault shouldBe an[IntegerSchema]
+    requiredIntWithDefault.asInstanceOf[IntegerSchema].getDefault shouldEqual 5
+
+    val annotatedIntWithDefault = model.value.getProperties.get("annotatedIntWithDefault")
+    annotatedIntWithDefault shouldBe an[IntegerSchema]
+    annotatedIntWithDefault.asInstanceOf[IntegerSchema].getDefault shouldEqual 10
+
+    val annotatedOptionalIntWithNoneDefault = model.value.getProperties.get("annotatedOptionalIntWithNoneDefault")
+    annotatedOptionalIntWithNoneDefault shouldBe an[IntegerSchema]
+    annotatedOptionalIntWithNoneDefault.asInstanceOf[IntegerSchema].getDefault should be(null)
+
+    val annotatedOptionalIntWithSomeDefault = model.value.getProperties.get("annotatedOptionalIntWithSomeDefault")
+    annotatedOptionalIntWithSomeDefault shouldBe an[IntegerSchema]
+    annotatedOptionalIntWithSomeDefault.asInstanceOf[IntegerSchema].getDefault should be(5)
+
+    val annotatedOptionalStringWithNoneDefault = model.value.getProperties.get("annotatedOptionalStringWithNoneDefault")
+    annotatedOptionalStringWithNoneDefault shouldBe an[StringSchema]
+    annotatedOptionalStringWithNoneDefault.asInstanceOf[StringSchema].getDefault should be(null)
+
+    nullSafeSeq(model.value.getRequired).toSet shouldEqual Set("requiredInt", "requiredIntWithDefault", "annotatedRequiredInt", "annotatedRequiredIntWithDefault", "annotatedIntWithDefault", "annotatedOptionalInt")
+  }
+
   it should "consider fields that aren't optional required if `requiredBasedAnnotation == true`" in new PropertiesScope[
     ModelWMultipleRequiredFields
   ](