Documentation for nested configuration properties in a native image uses @NestedConfigurationProperty too widely

[wilkinsona]

The documentation example looks like this:

@ConfigurationProperties(prefix = "my.properties")
public class MyProperties {

    private String name;

    @NestedConfigurationProperty
    private Nested nested = new Nested();

    // getters / setters...

    public static class Nested {

        private int number;

        // getters / setters...

    }

}

In this case, @NestedConfigurationProperty isn't required as Nested is already nested within MyProperties. It would be required if the code were structure like this:

@ConfigurationProperties(prefix = "my.properties")
public class MyProperties {

    private String name;

    @NestedConfigurationProperty
    private Nested nested = new Nested();

    // getters / setters...

}

public class Nested {

    private int number;

    // getters / setters...

}

[wilkinsona]

Thanks, @mhalbritter. Sorry, I wasn't very clear above and those changes aren't what I had in mind. Rather than removing @NestedConfigurationProperty I think we need to update the example so that it is required. We can then build on that in #33235 to add some further examples with records and Kotlin data classes.

[mhalbritter]

Ah, I see. I'll add an example showing when @NestedConfigurationProperties is needed.