Skip to content

Provide configuration properties documentation #40067

Open
@philwebb

Description

We currently link to source code for configuration properties info. E.g

For more detail, see the {spring-boot-actuator-autoconfigure-module-code}/web/server/ManagementServerProperties.java[`ManagementServerProperties`] source code and "`xref:ROOT:actuator/monitoring.adoc#actuator.monitoring.customizing-management-server-port[Customizing the Management Server Port]`" in the "`Production-ready features`" section.

We could link to javadoc, but because we use field javadoc it's not that useful. Perhaps we can generate a new type of api documentation based on the configuration json metadata instead. This could also replace https://docs.spring.io/spring-boot/docs/3.2.x/reference/htmlsingle/#appendix.application-properties.actuator

This might also allow configprop:...[] to become links.

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions