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.

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

Move re-exports into types and re-export AggregatedBytes #1085

Merged
merged 12 commits into from
Jan 28, 2022

Conversation

jdisanti
Copy link
Collaborator

@jdisanti jdisanti commented Jan 19, 2022

Motivation and Context

This implements #944.

Checklist

  • I have updated CHANGELOG.next.toml if I made changes to the smithy-rs codegen or runtime crates
  • I have updated CHANGELOG.next.toml if I made changes to the AWS SDK, generated SDK code, or SDK 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.

@jdisanti jdisanti requested a review from a team as a code owner January 19, 2022 02:14
@jdisanti jdisanti marked this pull request as draft January 19, 2022 02:14
@jdisanti
Copy link
Collaborator Author

Opening this PR as a draft to gather feedback. This change will also require updating all the examples, which I want to hold off on until consolidation is complete.

Open questions:

  1. Should the re-exported SdkError type follow other re-exports and be in the types module, or should it remain in root?
  2. Should we re-export types even if they're not used? For example, should ByteStream be re-exported by a service that has no streaming operations?

@github-actions
Copy link

A new generated diff is ready to view.

@github-actions
Copy link

A new doc preview is ready to view.

@Velfi
Copy link
Contributor

Velfi commented Jan 19, 2022

  • Should the re-exported SdkError type follow other re-exports and be in the types module, or should it remain in root?

I like setting and sticking to conventions so putting it in types makes sense to me unless that somehow makes codegen more difficult.

  • Should we re-export types even if they're not used? For example, should ByteStream be re-exported by a service that has no streaming operations?

On first thought, I think it shouldn't be re-exported. However, I'm worried about SDKs that add and then remove a bytestream based api. Is that something we need to consider or will that never happen?

@rcoh
Copy link
Collaborator

rcoh commented Jan 19, 2022

generally APIs can't be removed

@jdisanti
Copy link
Collaborator Author

jdisanti commented Jan 24, 2022

Will proceed with:

  1. All re-exports go into the types namespace
  2. Don't re-export unused types

Will also make Config and Client #[doc(inline)] to pull them into the structs section of the docs.

@jdisanti jdisanti marked this pull request as ready for review January 27, 2022 19:22
@jdisanti jdisanti requested a review from rcoh January 27, 2022 19:23
@github-actions
Copy link

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

@github-actions
Copy link

A new doc preview is ready to view.

@github-actions
Copy link

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

@jdisanti
Copy link
Collaborator Author

Examples fixed in awsdocs/aws-doc-sdk-examples#2776

@github-actions
Copy link

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

@jdisanti jdisanti mentioned this pull request Jan 28, 2022
10 tasks
@github-actions
Copy link

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

@jdisanti jdisanti merged commit a183f12 into main Jan 28, 2022
@jdisanti jdisanti deleted the jdisanti-reexports branch January 28, 2022 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants