Skip to content

Updated documentation for @ConfigurationProperties bean naming rules #34029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

Anubhav-2000
Copy link

@Anubhav-2000 Anubhav-2000 commented Jan 31, 2023

Added sample class with a prefix to clarify bean naming rules and fixed the corresponding documentation. Fixes #33437

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 31, 2023
@wilkinsona wilkinsona added this to the 2.7.x milestone Feb 14, 2023
@wilkinsona wilkinsona added for: merge-with-amendments Needs some changes when we merge type: dependency-upgrade A dependency upgrade and removed status: waiting-for-triage An issue we've not yet triaged labels Feb 14, 2023
@wilkinsona
Copy link
Member

wilkinsona commented Feb 14, 2023

Note for when we merge: SomeProperties does not need to be made public and can remain package-private.

Edit: Scratch that, the class becoming public makes it more consistent with other examples in the docs

@wilkinsona wilkinsona changed the title Updated documentation for @ConfigurationProperties bean naming rules #33437 Updated documentation for @ConfigurationProperties bean naming rules Feb 14, 2023
@wilkinsona wilkinsona self-assigned this Feb 14, 2023
@wilkinsona wilkinsona removed the for: merge-with-amendments Needs some changes when we merge label Feb 14, 2023
wilkinsona pushed a commit that referenced this pull request Feb 14, 2023
@wilkinsona wilkinsona added type: documentation A documentation update and removed type: dependency-upgrade A dependency upgrade labels Feb 14, 2023
@wilkinsona
Copy link
Member

@Anubhav-2000 Thanks very much for making your first contribution to Spring Boot.

@wilkinsona wilkinsona modified the milestones: 2.7.x, 2.6.15, 2.7.9 Feb 15, 2023
krenson pushed a commit to krenson/test-push that referenced this pull request Mar 15, 2023
…ot-starter-parent from 2.7.8 to 2.7.9 (patch)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [org.springframework.boot:spring-boot-starter-parent](https://spring.io/projects/spring-boot) ([source](https://github.com/spring-projects/spring-boot)) | parent | patch | `2.7.8` -> `2.7.9` |

---

### Release Notes

<details>
<summary>spring-projects/spring-boot</summary>

### [`v2.7.9`](https://github.com/spring-projects/spring-boot/releases/tag/v2.7.9)

[Compare Source](spring-projects/spring-boot@v2.7.8...v2.7.9)

#### 🐞 Bug Fixes

-   Maven Plugin's PropertiesMergingResourceTransformer closes InputStream when it should not do so [#&#8203;34063](spring-projects/spring-boot#34063)
-   Actuator Health web endpoint broken with Gson and Java 17 [#&#8203;34030](spring-projects/spring-boot#34030)
-   Dependency management for Mongo's Java Driver is incomplete [#&#8203;33941](spring-projects/spring-boot#33941)
-   Using devtools with Reactive application results in slower restarts [#&#8203;33855](spring-projects/spring-boot#33855)
-   Spies are not reset after test execution when using `@SpyBean` [#&#8203;33830](spring-projects/spring-boot#33830)
-   Properties Migrator does not detect properties of Map type that are marked as deprecated [#&#8203;27854](spring-projects/spring-boot#27854)

#### 📔 Documentation

-   Updated documentation for `@ConfigurationProperties` bean naming rules [#&#8203;34029](spring-projects/spring-boot#34029)
-   Restore "Use Jedis Instead of Lettuce" how-to documentation [#&#8203;33994](spring-projects/spring-boot#33994)
-   Add Redis application properties example [#&#8203;33965](spring-projects/spring-boot#33965)
-   Use Maven Central for release downloads in CLI installation documentation [#&#8203;33962](spring-projects/spring-boot#33962)
-   Actuator section is missing from documentation overview [#&#8203;33932](spring-projects/spring-boot#33932)
-   Add Javadoc since to OperationParameter.getAnnotation() [#&#8203;33914](spring-projects/spring-boot#33914)
-   Document additional configuration that is required for spring.mvc.throw-exception-if-no-handler-found=true to be effective [#&#8203;31660](spring-projects/spring-boot#31660)

#### 🔨 Dependency Upgrades

-   Upgrade to ActiveMQ 5.16.6 [#&#8203;34238](spring-projects/spring-boot#34238)
-   Upgrade to Byte Buddy 1.12.23 [#&#8203;34239](spring-projects/spring-boot#34239)
-   Upgrade to Dropwizard Metrics 4.2.16 [#&#8203;34240](spring-projects/spring-boot#34240)
-   Upgrade to Elasticsearch 7.17.9 [#&#8...
krenson pushed a commit to krenson/test-push that referenced this pull request Mar 15, 2023
…ot-starter-parent from 2.7.8 to 2.7.9 (patch)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [org.springframework.boot:spring-boot-starter-parent](https://spring.io/projects/spring-boot) ([source](https://github.com/spring-projects/spring-boot)) | parent | patch | `2.7.8` -> `2.7.9` |

---

### Release Notes

<details>
<summary>spring-projects/spring-boot</summary>

### [`v2.7.9`](https://github.com/spring-projects/spring-boot/releases/tag/v2.7.9)

[Compare Source](spring-projects/spring-boot@v2.7.8...v2.7.9)

#### 🐞 Bug Fixes

-   Maven Plugin's PropertiesMergingResourceTransformer closes InputStream when it should not do so [#&#8203;34063](spring-projects/spring-boot#34063)
-   Actuator Health web endpoint broken with Gson and Java 17 [#&#8203;34030](spring-projects/spring-boot#34030)
-   Dependency management for Mongo's Java Driver is incomplete [#&#8203;33941](spring-projects/spring-boot#33941)
-   Using devtools with Reactive application results in slower restarts [#&#8203;33855](spring-projects/spring-boot#33855)
-   Spies are not reset after test execution when using `@SpyBean` [#&#8203;33830](spring-projects/spring-boot#33830)
-   Properties Migrator does not detect properties of Map type that are marked as deprecated [#&#8203;27854](spring-projects/spring-boot#27854)

#### 📔 Documentation

-   Updated documentation for `@ConfigurationProperties` bean naming rules [#&#8203;34029](spring-projects/spring-boot#34029)
-   Restore "Use Jedis Instead of Lettuce" how-to documentation [#&#8203;33994](spring-projects/spring-boot#33994)
-   Add Redis application properties example [#&#8203;33965](spring-projects/spring-boot#33965)
-   Use Maven Central for release downloads in CLI installation documentation [#&#8203;33962](spring-projects/spring-boot#33962)
-   Actuator section is missing from documentation overview [#&#8203;33932](spring-projects/spring-boot#33932)
-   Add Javadoc since to OperationParameter.getAnnotation() [#&#8203;33914](spring-projects/spring-boot#33914)
-   Document additional configuration that is required for spring.mvc.throw-exception-if-no-handler-found=true to be effective [#&#8203;31660](spring-projects/spring-boot#31660)

#### 🔨 Dependency Upgrades

-   Upgrade to ActiveMQ 5.16.6 [#&#8203;34238](spring-projects/spring-boot#34238)
-   Upgrade to Byte Buddy 1.12.23 [#&#8203;34239](spring-projects/spring-boot#34239)
-   Upgrade to Dropwizard Metrics 4.2.16 [#&#8203;34240](spring-projects/spring-boot#34240)
-   Upgrade to Elasticsearch 7.17.9 [#&#8...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants