Unverified Commit 6c9402b4 authored by John DiSanti's avatar John DiSanti Committed by GitHub
Browse files

Improve generated documentation (#779) 



* Fill in missing generated documentation for S3

* Document the `smithy-types` runtime crate

* Fix wildcard imports

* Normalize doc notes

* Fix some CI issues

* Incorporate feedback

* Fix `EnumGeneratorTest`

* Fix more CI issues

* Fix server codegen tests

* Fix more doc issues

* Update changelogs

* Update aws/SDK_CHANGELOG.md

Co-authored-by: default avatarRussell Cohen <russell.r.cohen@gmail.com>

* Update aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsEndpointDecorator.kt

Co-authored-by: default avatarRussell Cohen <russell.r.cohen@gmail.com>

* Run pre-commit on all Kotlin files

* Use `emptySection`

* Fix namespace in doc comments
parent ddf1e01a

CHANGELOG.md

+4 −0
Original line number Diff line number Diff line
@@ -27,6 +27,10 @@ vNext (Month Day, Year) 
    - `smithy_types` -> `aws_smithy_types`

    - `smithy_xml` -> `aws_smithy_xml`



**New this week**



- Filled in missing docs for services in the rustdoc documentation (smithy-rs#779)



v0.26 (October 15th, 2021)

=======================

aws/SDK_CHANGELOG.md

+3 −0
Original line number Diff line number Diff line 
vNext (Month Day, Year)

=======================



**Breaking Changes**



- `CredentialsError` variants became non-exhaustive. This makes them impossible to construct directly outside of the `aws_types` crate. In order to construct credentials errors, new methods have been added for each variant. Instead of `CredentialsError::Unhandled(...)`, you should instead use `CredentialsError::unhandled`. Matching methods exist for all variants. (#781)

- The default credentials chain now returns `CredentialsError::CredentialsNotLoaded` instead of `ProviderError` when no credentials providers are configured.

- :warning: All Smithy runtime crates have been renamed to have an `aws-` prefix. This may require code changes:
@@ -30,6 +32,7 @@ vNext (Month Day, Year) 
**New this week**



- Moved the contents of `aws-auth` into the `aws-http` runtime crate (smithy-rs#783)

- Fix instances where docs were missing in generated services and add `#[warn_missing_docs]`  (smithy-rs#779)

- Add tracing output for resolved AWS endpoint (smithy-rs#784)

- Add support for the following Glacier customizations:

  - Set the ApiVersion header (smithy-rs#138, #787)

aws/rust-runtime/aws-config/src/environment/retry_config.rs

+4 −4
Original line number Diff line number Diff line
@@ -89,11 +89,11 @@ mod test { 
    }



    #[test]

    fn no_retry_config() {

        let builder = test_provider(&[]).retry_config_builder().unwrap();

    fn defaults() {

        let built = test_provider(&[]).retry_config_builder().unwrap().build();



        assert_eq!(builder.mode, None);

        assert_eq!(builder.max_attempts, None);

        assert_eq!(built.mode(), RetryMode::Standard);

        assert_eq!(built.max_attempts(), 3);

    }



    #[test]

aws/rust-runtime/aws-config/src/imds/client.rs

+2 −2
Original line number Diff line number Diff line
@@ -55,9 +55,9 @@ const DEFAULT_READ_TIMEOUT: Duration = Duration::from_secs(1); 
/// Client for IMDSv2. This client handles fetching tokens, retrying on failure, and token

/// caching according to the specified token TTL.

///

/// **NOTE:** This client ONLY supports IMDSv2. It will not fallback to IMDSv1. See

/// _Note: This client ONLY supports IMDSv2. It will not fallback to IMDSv1. See

/// [transitioning to IMDSv2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html#instance-metadata-transition-to-version-2)

/// for more information.

/// for more information._

///

/// # Client Configuration

/// The IMDS client can load configuration explicitly, via environment variables, or via

aws/rust-runtime/aws-config/src/imds/credentials.rs

+1 −1
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ use tokio::sync::OnceCell; 


/// IMDSv2 Credentials Provider

///

/// **Note**: This credentials provider will NOT fallback to the IMDSv1 flow.

/// _Note: This credentials provider will NOT fallback to the IMDSv1 flow._

#[derive(Debug)]

pub struct ImdsCredentialsProvider {

    client: LazyClient,