Skip to content
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

Rephrase auth trait documentation #2051

Merged
merged 1 commit into from
Nov 27, 2023
Merged

Rephrase auth trait documentation #2051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions smithy-aws-traits/src/main/resources/META-INF/smithy/aws.auth.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ structure cognitoUserPools {
providerArns: StringList
}

/// Signature Version 4 is the process to add authentication information to
/// AWS requests sent by HTTP. For security, most requests to AWS must be
/// signed with an access key, which consists of an access key ID and secret
/// access key. These two keys are commonly referred to as your security
/// credentials.
/// [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)
/// is the process to add authentication information to AWS requests sent by HTTP. For
/// security, most requests to AWS must be signed with an access key, which consists
/// of an access key ID and secret access key. These two keys are commonly referred to
/// as your security credentials.
@authDefinition(traits: [unsignedPayload])
@externalDocumentation(
Reference: "https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"
Expand Down
9 changes: 3 additions & 6 deletions smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,7 @@ structure authDefinition {
traits: TraitShapeIdList
}

/// Enables HTTP Basic Authentication as defined in RFC 2617 on a service
/// or operation.
/// HTTP Basic Authentication as defined in [RFC 2617](https://tools.ietf.org/html/rfc2617.html).
@trait(
selector: "service"
breakingChanges: [
Expand All @@ -258,8 +257,7 @@ structure authDefinition {
@externalDocumentation("RFC 2617": "https://tools.ietf.org/html/rfc2617.html")
structure httpBasicAuth {}

/// Enables HTTP Digest Authentication as defined in RFC 2617 on a service
/// or operation.
/// HTTP Digest Authentication as defined in [RFC 2617](https://tools.ietf.org/html/rfc2617.html).
@trait(
selector: "service"
breakingChanges: [
Expand All @@ -270,8 +268,7 @@ structure httpBasicAuth {}
@externalDocumentation("RFC 2617": "https://tools.ietf.org/html/rfc2617.html")
structure httpDigestAuth {}

/// Enables HTTP Bearer Authentication as defined in RFC 6750 on a service
/// or operation.
/// HTTP Bearer Authentication as defined in [RFC 6750](https://tools.ietf.org/html/rfc6750.html).
@trait(
selector: "service"
breakingChanges: [
Expand Down