Skip to content

Commit 75e5630

Browse files
Fix typos in auth doc
Co-authored-by: Nate Prewitt <[email protected]>
1 parent 6dbca91 commit 75e5630

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

designs/auth.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,12 @@ class Identity(Protocol):
105105
```
106106

107107
An `Identity` may be derived from any number of sources, such as configuration
108-
properties or environement variables. These different sources are loaded by an
108+
properties or environment variables. These different sources are loaded by an
109109
[`IdentityResolver`](#identity-resolvers).
110110

111111
### Identity Resolvers
112112

113-
Identity resolvers are responsible for contructiong an `Identity` for a request.
113+
Identity resolvers are responsible for constructing an `Identity` for a request.
114114

115115
```python
116116
class IdentityResolver[I: Identity, IP: Mapping[str, Any]](Protocol):
@@ -120,14 +120,14 @@ class IdentityResolver[I: Identity, IP: Mapping[str, Any]](Protocol):
120120
```
121121

122122
Each identity source SHOULD have its own identity resolver implementation. If an
123-
`Identity` is supported by multiple `IdentityResolver`s, those resolver SHOULD
123+
`Identity` is supported by multiple `IdentityResolver`s, those resolvers SHOULD
124124
be prioritized to provide a stable resolution strategy. A
125125
`ChainedIdentityResolver` implementation is provided that implements this
126126
behavior generically.
127127

128128
The `get_identity` function takes only one (keyword-only) argument - a mapping
129129
of properties that is refined by the `IP` generic parameter. The identity
130-
properties are contructed by the `AuthScheme`'s `identity_properties` method.
130+
properties are constructed by the `AuthScheme`'s `identity_properties` method.
131131

132132
Identity resolvers are constructed by the `AuthScheme`'s `identity_resolver`
133133
method.
@@ -153,7 +153,7 @@ request.
153153

154154
### Event Signers
155155

156-
Auh schemes MAY also have an associated event signer, which signs events that
156+
Auth schemes MAY also have an associated event signer, which signs events that
157157
are sent to a server. They behave in the same way as normal signers, except that
158158
they sign an event instead of a transport request. The properties passed to this
159159
signing method are identical to those pased to the request signer.
@@ -168,7 +168,7 @@ class EventSigner[I, SP: Mapping[str, Any]](Protocol):
168168

169169
## Configuration
170170

171-
All services with at least one auth trait will have the following properites on
171+
All services with at least one auth trait will have the following properties on
172172
their configuration object.
173173

174174
```python

packages/smithy-core/src/smithy_core/aio/interfaces/auth.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ async def sign(self, *, request: R, identity: I, properties: SP) -> R:
2424

2525

2626
class EventSigner[I, SP: Mapping[str, Any]](Protocol):
27-
"""A class that signs requests before they are sent."""
27+
"""A class that signs events before they are sent."""
2828

2929
# TODO: add a protocol type for events
3030
async def sign(self, *, event: Any, identity: I, properties: SP) -> Any:

packages/smithy-core/src/smithy_core/auth.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ class AuthOption:
3434
"""The ID of the auth scheme to use."""
3535

3636
identity_properties: _TypedProperties = field(default_factory=TypedProperties)
37-
"""Paramters to pass to the identity resolver method."""
37+
"""Parameters to pass to the identity resolver method."""
3838

3939
signer_properties: _TypedProperties = field(default_factory=TypedProperties)
40-
"""Paramters to pass to the signing method."""
40+
"""Parameters to pass to the signing method."""
4141

4242

4343
class DefaultAuthResolver:

packages/smithy-core/src/smithy_core/interfaces/auth.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ class AuthOption(Protocol):
1717
"""The ID of the auth scheme to use."""
1818

1919
identity_properties: TypedProperties
20-
"""Paramters to pass to the identity resolver method."""
20+
"""Parameters to pass to the identity resolver method."""
2121

2222
signer_properties: TypedProperties
23-
"""Paramters to pass to the signing method."""
23+
"""Parameters to pass to the signing method."""
2424

2525

2626
class AuthSchemeResolver(Protocol):

0 commit comments

Comments
 (0)