Skip to content

feat: codegen for waitUntil[State] #318

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

Merged
merged 12 commits into from
May 7, 2021

Conversation

alexforsyth
Copy link
Contributor

Issue #, if available:
Code generation for: aws/aws-sdk-js-v3#2302

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@alexforsyth alexforsyth changed the base branch from master to main April 23, 2021 20:43
…/typescript/codegen/WaiterGenerator.java

Co-authored-by: Trivikram Kamat <[email protected]>
writer.writeDocs(waiter.getDocumentation().orElse("") + " \n"
+ " @param params : Waiter configuration options.\n"
+ " @param input : the input to " + operationSymbol.getName() + " for polling.");
+ " @deprecated In favor of waitUntil" + waiterName + ". This does not throw on failure.\n"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
+ " @deprecated In favor of waitUntil" + waiterName + ". This does not throw on failure.\n"
+ " @deprecated Use `waitUntil" + waiterName + "` instead."
+ " The `waitFor" + waiterName + "` does not throw error in non-success cases.\n"

writer.addImport("WaiterConfiguration", "WaiterConfiguration", WAITABLE_UTIL_PACKAGE);

// generates the now deprecated WaitFor....
writer.writeDocs(waiter.getDocumentation().orElse("") + " \n"
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove waiter documentation, as waitFor is deprecated. Users should read documentation for waitUntil instead.

Suggested change
writer.writeDocs(waiter.getDocumentation().orElse("") + " \n"
writer.writeDocs(

@alexforsyth alexforsyth merged commit d3caadd into smithy-lang:main May 7, 2021
srchase pushed a commit to srchase/smithy-typescript that referenced this pull request Mar 17, 2023
* feat: creating codegen for WaitUntilState

* fix: spacing

* Update smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/WaiterGenerator.java

Co-authored-by: Trivikram Kamat <[email protected]>

* feat: throw a new error object

* fix: minor updates

* fix: param annotation in doc generator

* fix: capitalization

* fix: remove old documentation

* fix: documentation spacing

Co-authored-by: Trivikram Kamat <[email protected]>
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