Skip to content

chore: Miscellaneous comment fixes / updates #1752

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 17, 2024
Merged

chore: Miscellaneous comment fixes / updates #1752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8596608
Miscellaneous comment updates
Sep 16, 2024
8cb98b6
Merge branch 'main' into chore/comment-fixes
sichanyoo Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions ...Core/AWSClientRuntime/Sources/AWSClientRuntime/Config/AWSDefaultClientConfiguration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import SmithyIdentityAPI
public protocol AWSDefaultClientConfiguration {
/// The AWS credential identity resolver to be used for AWS credentials.
///
/// If no resolver is supplied, the SDK will look for credentials in the environment, then in the `~/.aws/credentials` file.
/// If no resolver is supplied, `AWSSDKIdentity.DefaultAWSCredentialIdentityResolverChain` gets used by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we document the specific order of resolvers in this chain?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured that for customers that really want to know, they can locate that component and look at doc comments on that given there's the module name and component name. Thought we would rather avoid duplicating doc comments.

var awsCredentialIdentityResolver: any AWSCredentialIdentityResolver { get set }

/// Specifies whether FIPS endpoints should be used.
Expand All @@ -20,12 +20,11 @@ public protocol AWSDefaultClientConfiguration {
/// Specifies whether dual-stack endpoints should be used.
var useDualStack: Bool? { get set }

/// An identifying string for the application being used with this SDK.
/// An identifying string for the application using the SDK.
///
/// This value is set after resolving app ID from the standard progression of potential sources.
/// The application ID is submitted as part of the `user-agent` request header that allows analyzing SDK usage and troubleshooting.
///
/// The application ID is submitted as part of the `user-agent` and allows for better tracking and troubleshooting.
/// The application ID may also be retrieved from the environment variable `AWS_SDK_UA_APP_ID` or from the
/// The application ID may be retrieved from the environment variable `AWS_SDK_UA_APP_ID` or from the
/// configuration file field `sdk_ua_app_id` if it is not set here.
var appID: String? { get set }

Expand Down
2 changes: 1 addition & 1 deletion ...DKIdentity/AWSCredentialIdentityResolvers/DefaultAWSCredentialIdentityResolverChain.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import protocol SmithyIdentity.AWSCredentialIdentityResolvedByCRT
/// A credential identity resolver that uses the default AWS credential identity resolver chain used by most AWS SDKs.
/// This is the default resolver when no credential identity resolver is provided by the user.
///
/// The chain resolves the credneital identity in the following order:
/// The chain resolves the credential identity in the following order:
/// 1. Environment
/// 2. Profile
/// 3. Web Identity Tokens (STS Web Identity)
Expand Down
Loading