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

docs(types): improve streaming payload types #4987

Merged
merged 1 commit into from
Jul 26, 2023
Merged

Conversation

kuhe
Copy link
Contributor

@kuhe kuhe commented Jul 19, 2023

Issue

closes #4933

codegen for smithy-lang/smithy-typescript#835

Description

replaces inline union types representing payload blobs with a type alias (equivalent) that centralizes documentation and context for how to use those types.

@kuhe kuhe force-pushed the feat/stream-typings branch 2 times, most recently from bda01ce to 6b225cf Compare July 25, 2023 16:30
@kuhe kuhe requested a review from a team as a code owner July 25, 2023 16:30
@kuhe kuhe force-pushed the feat/stream-typings branch 2 times, most recently from 4f56c9f to c4867bf Compare July 25, 2023 19:54
@kuhe
Copy link
Contributor Author

kuhe commented Jul 25, 2023

  • ran integration tests
  • ran cucumber e2e tests

@kuhe kuhe force-pushed the feat/stream-typings branch from c4867bf to b99dfea Compare July 26, 2023 13:43
@@ -108,3 +108,36 @@ if (errors.length) {
const violations = errors.join(", ");
throw new Error(violations + " have inconsistent declared versions.");
}

for (const pkg of nonClientPackages) {
Copy link
Contributor

Choose a reason for hiding this comment

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

The generated protocol test packages in /private should have their dependencies updated the same way as client packages. Should those get handled separately? They shouldn't ever be out of sync with the clients anyways, but this could potentially paper over an issue where they get updated independently of the right codegen changes being applied to those test packages.

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've moved the private entries into the client list so they get checked and contribute to the canonical version that gets written to the rest of the packages.

@kuhe kuhe force-pushed the feat/stream-typings branch 2 times, most recently from 2473b26 to 68092dd Compare July 26, 2023 16:58
@kuhe kuhe force-pushed the feat/stream-typings branch from 68092dd to a79f577 Compare July 26, 2023 16:59
@kuhe kuhe merged commit 9693841 into aws:main Jul 26, 2023
@kuhe kuhe deleted the feat/stream-typings branch July 26, 2023 17:34
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

create a type alias for http payloads
4 participants