Skip to content

S
spring-boot
Commit 182ce215 authored by Phillip Webb's avatar Phillip Webb
Browse files
Options

Clarify configuration meta-data details 

Update the configuration meta-data appendix to clarify a few things.
parent 460bf710
Show whitespace changes
Inline Side-by-side
Showing with 7 additions and 10 deletions
spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc
View file @ 182ce215
...@@ -83,7 +83,9 @@ The JSON object contained in the `groups` array can contain the following attrib ...@@ -83,7 +83,9 @@ The JSON object contained in the `groups` array can contain the following attrib
|`description` |`description`
| String | String
| A short description of the group that can be displayed to users. May be omitted if no | A short description of the group that can be displayed to users. May be omitted if no
description is available. description is available. It is recommended that descriptions are a short paragraphs,
with the first line providing a concise summary. The last line in the description should
end with a period (`.`).
|`sourceType` |`sourceType`
| String | String
...@@ -125,8 +127,10 @@ The JSON object contained in the `properties` array can contain the following at ...@@ -125,8 +127,10 @@ The JSON object contained in the `properties` array can contain the following at
|`description` |`description`
| String | String
| A short description of the property that can be displayed to users. May be omitted if | A short description of the group that can be displayed to users. May be omitted if no
no description is available. description is available. It is recommended that descriptions are a short paragraphs,
with the first line providing a concise summary. The last line in the description should
end with a period (`.`).
|`sourceType` |`sourceType`
| String | String
...@@ -135,12 +139,6 @@ The JSON object contained in the `properties` array can contain the following at ...@@ -135,12 +139,6 @@ The JSON object contained in the `properties` array can contain the following at
would contain the fully qualified name of that class. May be omitted if the source type would contain the fully qualified name of that class. May be omitted if the source type
is not known. is not known.
|`sourceMethod`
| String
| The full name of the method (include parenthesis and argument types) that contributed
this property. For example, the name of a getter in a `@ConfigurationProperties`
annotated class. May be omitted if the source method is not known.
|`defaultValue` |`defaultValue`
| Object | Object
| The default value which will be used if the property is not specified. May be omitted | The default value which will be used if the property is not specified. May be omitted
...@@ -236,4 +234,3 @@ such cases, the annotation processor will automatically merge items from ...@@ -236,4 +234,3 @@ such cases, the annotation processor will automatically merge items from
The format of the `additional-spring-configuration-metadata.json` file is exactly the same The format of the `additional-spring-configuration-metadata.json` file is exactly the same
as the regular `spring-configuration-metadata.json`. The additional properties file is as the regular `spring-configuration-metadata.json`. The additional properties file is
optional, if you don't have any additional properties, simply don't add it. optional, if you don't have any additional properties, simply don't add it.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment