mercedes-benz / sechub

SecHub provides a central API to test software with different security tools.
https://mercedes-benz.github.io/sechub/
MIT License
259 stars 58 forks source link

Auto documentation shall support ConfigurationProperties as well #3215

Open de-jcup opened 2 weeks ago

de-jcup commented 2 weeks ago

Situation

Currently we support only @Value inside the auto documentation of properties But the @ConfigurationProperties mentioned in #3212 are currently not supported.

Wanted

The SystemPropertiesJavaLaunchExampleGenerator , ScheduleDescriptionGenerator and PDSExecutorConfigurationParameterDescriptionGenerator (maybe more) shall generate configuration properties as well

Solution

We implement a ConfigurationPropertiesExtractor like SpringValueExtractor and use it from caller side for the configuration properties the same way done for values.

The ConfigurationPropertiesExtractor must inspect the prefix attribute and must also inspect the fields of the annotated class etc.