docs: Update API documentation to reflect AWS_SDK_UA_APP_ID

aws · Apr 26, 2024 · cd07e59 · cd07e59
1 parent b5b386a
commit cd07e59
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git a/generator/.DevConfigs/badea440-a10b-41a1-a8e3-1e6dcdb890a4.json b/generator/.DevConfigs/badea440-a10b-41a1-a8e3-1e6dcdb890a4.json
@@ -0,0 +1,9 @@
+{
+    "core": {
+        "updateMinimum": true,
+        "type": "Patch",
+        "changeLogMessages": [
+            "Update API documentation for the `ClientConfig.ClientAppId` property"
+        ]
+    }
+}
diff --git a/sdk/src/Core/Amazon.Runtime/ClientConfig.cs b/sdk/src/Core/Amazon.Runtime/ClientConfig.cs
@@ -919,9 +919,16 @@ public long RequestMinCompressionSizeBytes
         }
 
         /// <summary>
-        /// Customers can opt-in to provide an app id that is intended to identify their applications
-        /// in the user agent header string. The value must not exceed <see cref="EnvironmentVariableInternalConfiguration.AWS_SDK_UA_APP_ID_MAX_LENGTH"/> characters.
+        /// <para>
+        /// ClientAppId is an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of <c>app/{ClientAppId}</c>. 
+        /// </para>
+        /// <para>
+        /// If the ClientAppId is not set on the object the SDK will search the environment variable <c>AWS_SDK_UA_APP_ID</c> and the shared config profile attribute <c>sdk_ua_app_id</c> for a potential value for the ClientAppId.
+        /// </para>
         /// </summary>
+        /// <remarks>
+        /// See <see href="https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html"/> for more information on environment variables and shared config settings.
+        /// </remarks>
         public string ClientAppId
         {
             get

diff --git a/sdk/src/Core/Amazon.Runtime/IClientConfig.cs b/sdk/src/Core/Amazon.Runtime/IClientConfig.cs
@@ -274,9 +274,16 @@ public partial interface IClientConfig
         long RequestMinCompressionSizeBytes { get; }
 
         /// <summary>
-        /// Customers can opt-in to provide an app id that is intended to identify their applications
-        /// in the user agent header string. The value should have a maximum length of 50.
+        /// <para>
+        /// ClientAppId is an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of <c>app/{ClientAppId}</c>. 
+        /// </para>
+        /// <para>
+        /// If the ClientAppId is not set on the object the SDK will search the environment variable <c>AWS_SDK_UA_APP_ID</c> and the shared config profile attribute <c>sdk_ua_app_id</c> for a potential value for the ClientAppId.
+        /// </para>
         /// </summary>
+        /// <remarks>
+        /// See <see href="https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html"/> for more information on environment variables and shared config settings.
+        /// </remarks>
         string ClientAppId { get; }
 
         /// <summary>