clarify appConfiguration (#33567)

Azure · Feb 17, 2023 · f9eadbc · f9eadbc
1 parent 51ab385
commit f9eadbc
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/.../cloud/autoconfigure/implementation/appconfiguration/AzureAppConfigurationProperties.java b/.../cloud/autoconfigure/implementation/appconfiguration/AzureAppConfigurationProperties.java
@@ -16,15 +16,15 @@ public class AzureAppConfigurationProperties extends AbstractAzureHttpConfigurat
     public static final String PREFIX = "spring.cloud.azure.appconfiguration";
 
     /**
-     * Endpoint of the Azure App Configuration instance.
+     * Endpoint of the Azure App Configuration instance. For instance, 'https://{appConfigurationName}.azconfig.io'.
      */
     private String endpoint;
     /**
      * Connection string of the Azure App Configuration instance.
      */
     private String connectionString;
     /**
-     * Version of the app configuration service to be used when making request.
+     * Version of the app configuration service to be used when making request. The default value is `"1.0"`.
      */
     private ConfigurationServiceVersion serviceVersion;
 

diff --git a/...plementation/properties/resourcemanager/AzureResourceMetadataConfigurationProperties.java b/...plementation/properties/resourcemanager/AzureResourceMetadataConfigurationProperties.java
@@ -19,7 +19,7 @@ public class AzureResourceMetadataConfigurationProperties implements AzureResour
      */
     private String resourceId;
     /**
-     * The region of an Azure resource.
+     * The region of an Azure resource. For instance, '"eastus"'.
      */
     private String region;
 

diff --git a/...ng/cloud/autoconfigure/properties/core/retry/ExponentialRetryConfigurationProperties.java b/...ng/cloud/autoconfigure/properties/core/retry/ExponentialRetryConfigurationProperties.java
@@ -21,7 +21,7 @@ public class ExponentialRetryConfigurationProperties implements RetryOptionsProv
      */
     private Duration baseDelay;
     /**
-     * Maximum permissible amount of time between retry attempts.
+     * Maximum permissible amount of time(duration) between retry attempts.
      */
     private Duration maxDelay;
 

diff --git a/...e-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/...e-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -822,7 +822,7 @@
     {
       "name": "spring.cloud.azure.region",
       "type": "java.lang.String",
-      "description": "The region of an Azure resource. This is a legacy property.",
+      "description": "The region of an Azure resource. For instance, '\"eastus\"'. This is a legacy property.",
       "deprecation": {
         "level": "error",
         "reason": "Deprecate to move all resource related under 'spring.cloud.azure.<azure-service>.resource' prefix."
@@ -860,7 +860,7 @@
     {
       "name": "spring.cloud.azure.servicebus.retry-options.max-delay",
       "type": "java.time.Duration",
-      "description": "Maximum permissible amount of time between retry attempts. This is a legacy property.",
+      "description": "Maximum permissible amount of time(duration) between retry attempts. This is a legacy property.",
       "deprecation": {
         "level": "error",
         "reason": "Deprecate to keep consistent with the unified configuration options.",
@@ -1469,7 +1469,7 @@
     {
       "name": "spring.cloud.azure.keyvault.secret.property-sources[0].resource.region",
       "type": "java.lang.String",
-      "description": "The region of an Azure resource.",
+      "description": "The region of an Azure resource. For instance, '\"eastus\"'.",
       "sourceType": "com.azure.spring.cloud.autoconfigure.implementation.properties.resourcemanager.AzureResourceMetadataConfigurationProperties"
     },
     {
@@ -1493,7 +1493,7 @@
     {
       "name": "spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-delay",
       "type": "java.time.Duration",
-      "description": "Maximum permissible amount of time between retry attempts.",
+      "description": "Maximum permissible amount of time(duration) between retry attempts.",
       "sourceType": "com.azure.spring.cloud.autoconfigure.properties.core.retry.ExponentialRetryConfigurationProperties"
     },
     {

diff --git a/...rc/main/java/com/azure/spring/cloud/core/properties/retry/ExponentialRetryProperties.java b/...rc/main/java/com/azure/spring/cloud/core/properties/retry/ExponentialRetryProperties.java
@@ -21,7 +21,7 @@ public class ExponentialRetryProperties implements RetryOptionsProvider.RetryOpt
      */
     private Duration baseDelay;
     /**
-     * Maximum permissible amount of time between retry attempts.
+     * Maximum permissible amount of time(duration) between retry attempts.
      */
     private Duration maxDelay;