fix: save parent field information to type resolver's target queue (#2159)

* fix: save parent field information to type resolver's target queue

Adjust tests that no longer make sense

Signed-off-by: Michael Edgar <[email protected]>

* Remove unnecessary conditions

Signed-off-by: Michael Edgar <[email protected]>

---------

Signed-off-by: Michael Edgar <[email protected]>

Author: MikeEdgar

core/src/main/java/io/smallrye/openapi/runtime/scanner/dataobject/TypeResolver.java

@@ -285,6 +285,7 @@ public FieldInfo getField() {
 
     private void setField(FieldInfo field) {
         this.field = field;
+        targets.add(field);
     }
 
     /**
@@ -824,7 +825,9 @@ private static void scanField(AnnotationScannerContext context, Map<String, Type
         if (properties.containsKey(propertyName)) {
             resolver = properties.get(propertyName);
 
-            if (resolver.getField() == null && (Modifier.isPublic(field.flags()) || Modifier.isProtected(field.flags()))) {
+            if (resolver.getField() == null && (Modifier.isPublic(field.flags())
+                    || Modifier.isProtected(field.flags())
+                    || context.getConfig().privatePropertiesEnable())) {
                 /*
                  * Field is declared in parent class and the getter/setter was
                  * declared/overridden in child class

core/src/test/java/io/smallrye/openapi/runtime/scanner/StandaloneSchemaScanTest.java

@@ -901,4 +901,47 @@ class Bean {
 
         assertJsonEquals("components.schemas.multi-array-generic.json", Bean.class);
     }
+
+    static class ParentClassFieldSchemaAnnotationTestClasses {
+        static Class<?>[] CLASSES = {
+                FieldInterface.class,
+                ParentClass.class,
+                ChildClass.class
+        };
+
+        interface FieldInterface {
+            public String getRequiredField();
+
+            public void setRequiredField(String requiredField);
+        }
+
+        class ParentClass {
+            @jakarta.validation.constraints.Size(min = 1, max = 32)
+            @jakarta.validation.constraints.NotNull
+            @Schema(readOnly = true, description = "Required field", examples = "Required field data")
+            private String requiredField;
+
+            public void setRequiredField(String requiredField) {
+                this.requiredField = requiredField;
+            }
+
+            public String getRequiredField() {
+                return this.requiredField;
+            }
+        }
+
+        @Schema(description = "Child class description")
+        class ChildClass extends ParentClass implements FieldInterface {
+            @jakarta.validation.constraints.Size(min = 1, max = 32)
+            @jakarta.validation.constraints.NotNull
+            @Schema(readOnly = true, description = "Other field", examples = "other field data")
+            private String otherField;
+        }
+
+    }
+
+    @Test
+    void testParentClassFieldSchemaAnnotation() throws IOException, JSONException {
+        assertJsonEquals("components.schemas.annotated-parent-field.json", ParentClassFieldSchemaAnnotationTestClasses.CLASSES);
+    }
 }

core/src/test/java/io/smallrye/openapi/runtime/scanner/dataobject/TypeResolverTests.java

@@ -171,7 +171,7 @@ void testAnnotatedInterfaceMethodOverridesImplMethod(AnnotationScannerContext co
         assertEquals("c_name", schema.value("name").asString());
         assertEquals(50, schema.value("maxLength").asInt());
         assertEquals("The name of the canine", schema.value("description").asString());
-        assertArrayEquals(new String[] { "age", "type", "c_name", "bark", "speciesName", "extinct" },
+        assertArrayEquals(new String[] { "age", "pet_type", "c_name", "bark", "speciesName", "extinct" },
                 properties.values().stream().map(TypeResolver::getPropertyName).toArray());
     }
 

core/src/test/java/test/io/smallrye/openapi/runtime/scanner/dataobject/AbstractAnimal.java

@@ -6,7 +6,6 @@
 @com.fasterxml.jackson.annotation.JsonPropertyOrder(value = { "age", "type" })
 public abstract class AbstractAnimal implements Animal {
 
-    @Schema
     private String type;
     protected Integer age;
     private boolean extinct;

core/src/test/resources/io/smallrye/openapi/runtime/scanner/components.schemas.annotated-parent-field.json

@@ -0,0 +1,30 @@
+{
+  "openapi" : "3.1.0",
+  "components" : {
+    "schemas" : {
+      "ChildClass" : {
+        "description" : "Child class description",
+        "type" : "object",
+        "required" : [ "requiredField", "otherField" ],
+        "properties" : {
+          "requiredField" : {
+            "type" : "string",
+            "description" : "Required field",
+            "readOnly" : true,
+            "examples" : [ "Required field data" ],
+            "minLength" : 1,
+            "maxLength" : 32
+          },
+          "otherField" : {
+            "type" : "string",
+            "description" : "Other field",
+            "readOnly" : true,
+            "examples" : [ "other field data" ],
+            "minLength" : 1,
+            "maxLength" : 32
+          }
+        }
+      }
+    }
+  }
+}