Merge pull request #3482 from swagger-api/issue-3259

refs #3259 - fix required annotation processing for reference properties

Author: frantuma

modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/ModelResolver.java

@@ -654,15 +654,15 @@ public Schema resolve(AnnotatedType annotatedType, ModelConverterContext context
                 property = clone(context.resolve(aType));
 
                 if (property != null) {
-                    if (property.get$ref() == null) {
-                        Boolean required = md.getRequired();
-                        if (required != null && !Boolean.FALSE.equals(required)) {
+                    Boolean required = md.getRequired();
+                    if (required != null && !Boolean.FALSE.equals(required)) {
+                        addRequiredItem(model, propName);
+                    } else {
+                        if (propDef.isRequired()) {
                             addRequiredItem(model, propName);
-                        } else {
-                            if (propDef.isRequired()) {
-                                addRequiredItem(model, propName);
-                            }
                         }
+                    }
+                    if (property.get$ref() == null) {
                         if (accessMode != null) {
                             switch (accessMode) {
                                 case AUTO:

modules/swagger-core/src/test/java/io/swagger/v3/core/oas/models/RequiredRefFieldModel.java

@@ -0,0 +1,26 @@
+package io.swagger.v3.core.oas.models;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement
+public class RequiredRefFieldModel {
+
+    @XmlElement(name = "a")
+    @Schema(required = true)
+    public String getA() {
+        return "aaa";
+    }
+
+    @XmlElement(name = "b")
+    @Schema(required = true)
+    public B getB() {
+        return null;
+    }
+
+    static class B {
+        public String foo;
+    }
+}

modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/RequiredFieldModelTest.java

@@ -2,6 +2,7 @@
 
 import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.oas.models.ApiFirstRequiredFieldModel;
+import io.swagger.v3.core.oas.models.RequiredRefFieldModel;
 import io.swagger.v3.core.oas.models.XmlFirstRequiredFieldModel;
 import io.swagger.v3.oas.models.media.Schema;
 import org.testng.annotations.Test;
@@ -29,4 +30,17 @@ public void testApiModelPropertySecondPosition() {
         assertNotNull(prop);
         assertTrue(model.getRequired().contains("a"));
     }
+
+
+    @Test(description = "it should apply required flag also to ref fields")
+    public void testApiModelRefProperty() {
+        final Map<String, Schema> models = ModelConverters.getInstance().readAll(RequiredRefFieldModel.class);
+        final Schema model = models.get("RequiredRefFieldModel");
+        final Schema prop = (Schema) model.getProperties().get("a");
+        assertNotNull(prop);
+        final Schema prop2 = (Schema) model.getProperties().get("b");
+        assertNotNull(prop2);
+        assertTrue(model.getRequired().contains("a"));
+        assertTrue(model.getRequired().contains("b"));
+    }
 }

pom.xml

@@ -505,7 +505,7 @@
         <joda-time-version>2.9.9</joda-time-version>
         <snakeyaml-version>1.24</snakeyaml-version>
         <jakarta.ws-version>2.1.6</jakarta.ws-version>
-        <felix-version>3.5.0</felix-version>
+        <felix-version>4.2.1</felix-version>
         <servlet-api-version>4.0.3</servlet-api-version>
         <jersey2-version>2.26</jersey2-version>
         <jackson-version>2.10.1</jackson-version>