server.reactive.session.cookie properties are not documented

Hi, this is a first-timers-only issue. This means we’ve worked to make it more understandable to people who haven’t contributed to our codebase before and are just getting started with making open source contributions in general.

If that’s you, we’re interested in helping you take the first step and can answer questions and help you out as you do. Those questions can be about the code, working with Git and GitHub – anything that you need some help with to make the contribution. Note that we’re especially interested in contributions from people from groups underrepresented in free and open source software!

If you have had a pull request merged before, consider leaving this one for someone new, and looking through our general ideal-for-contribution issues. Thanks!

Problem

@DidierLoiseau has pointed out that the server.reactive.session.cookie properties are not documented. This means that they aren’t listed in the reference documentation or in the metadata that enables auto-completion in an IDE when editing application.properties and application.yaml files.

The entries in the reference documentation are generated from the metadata so it’s the metadata that needs to be corrected. It is generated using an annotation processor. The properties are defined on a Cookie class, an instance of which is used by ServerProperties.Reactive.Session:

https://github.com/spring-projects/spring-boot/blob/a4bafa88bc167eaff7e0cbf7bfe36da742db2b15/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java#L326

The annotation processor doesn’t know that Cookie contains nested configuration properties so no metadata is generated.

Solution

org.springframework.boot.autoconfigure.web.ServerProperties.Reactive.Session should be updated to add @NestedConfigurationProperties to its cookie field. The source for this class is in ServerProperties.java that can be found at spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java in your git clone of the codebase.

The reference documentation can then be built (./gradlew spring-boot-project:spring-boot-docs:asciidoctor) to check that the property is now documented. The built documentation can be found beneath spring-boot-project/spring-boot-docs/build/docs/.

Steps to Fix

• Claim this issue with a comment below and ask any clarifying questions you need
• Set up a repository locally following the Contributing Guidelines
• Try to fix the issue following the steps above
• Commit your changes and start a pull request.

[wilkinsona]

As this is a first-timers-only issue, we want to keep the scope quite narrow. If further changes are necessary, we’ll open another issue to tackle those. Thanks for the suggestions.

[wilkinsona]

I would import everything by pointing your IDE at the root of your local git clone of the code.