Skip to content

Commit c45dc12

Browse files
Updating docs for app_name on ConfigLoader (#3645)
## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here --> Docs indicating that the `AppName` can be loaded from an environment variable or profile key were buried in the default provider and would be hard to find for users. ## Description <!--- Describe your changes in detail --> This change adds documentation to the `app_name` method on `ConfigLoader` that makes the options for loading the `AppName` more explicit. ## Testing <!--- Please describe in detail how you tested your changes --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> Ran `cargo doc` to ensure the docs were generated correctly ## Checklist <!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked --> - [x] I have updated `CHANGELOG.next.toml` if I made changes to the smithy-rs codegen or runtime crates ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: ysaito1001 <awsaito@amazon.com>
1 parent 1ccf22d commit c45dc12

File tree

4 files changed

+15
-3
lines changed

4 files changed

+15
-3
lines changed

CHANGELOG.next.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,8 @@ references = ["aws-sdk-rust#1079"]
3636
meta = { "breaking" = false, "bug" = true, "tada" = false }
3737
author = "rcoh"
3838

39-
39+
[[aws-sdk-rust]]
40+
message = "Updating the documentation for the `app_name` method on `ConfigLoader` to indicate the order of precedence for the sources of the `AppName`."
41+
references = ["smithy-rs#3645"]
42+
meta = { "breaking" = false, "bug" = false, "tada" = false }
43+
author = "landonxjames"

aws/rust-runtime/aws-config/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "aws-config"
3-
version = "1.4.0"
3+
version = "1.4.1"
44
authors = [
55
"AWS Rust SDK Team <aws-sdk-rust@amazon.com>",
66
"Russell Cohen <rcoh@amazon.com>",

aws/rust-runtime/aws-config/src/lib.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,9 +532,16 @@ mod loader {
532532

533533
/// Override the name of the app used to build [`SdkConfig`].
534534
///
535-
/// This _optional_ name is used to identify the application in the user agent that
535+
/// This _optional_ name is used to identify the application in the user agent header that
536536
/// gets sent along with requests.
537537
///
538+
/// The app name is selected from an ordered list of sources:
539+
/// 1. This override.
540+
/// 2. The value of the `AWS_SDK_UA_APP_ID` environment variable.
541+
/// 3. Profile files from the key `sdk_ua_app_id`
542+
///
543+
/// If none of those sources are set the value is `None` and it is not added to the user agent header.
544+
///
538545
/// # Examples
539546
/// ```no_run
540547
/// # async fn create_config() {

tools/ci-build/changelogger/smithy-rs-maintainers.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ drganjoo
99
rschmitt
1010
rhernandez35
1111
aajtodd
12+
landonxjames

0 commit comments

Comments
 (0)