Skip to content

Conversation

aBurmeseDev
Copy link
Contributor

@aBurmeseDev aBurmeseDev commented Mar 4, 2025

Fixes aws/aws-sdk-js-v3#5761, JS-6001

  • Deprecated commands aren't marked deprecated because of missing deprecated messages in service models (ref). The fix is to add a default message after tsdoc @deprecated annotations.

Description of changes:

  • Replace empty deprecation messages with fallback message "deprecated"
  • Check for deprecatedTrait message and render it properly

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

@aBurmeseDev aBurmeseDev marked this pull request as ready for review March 4, 2025 07:04
@aBurmeseDev aBurmeseDev requested a review from a team as a code owner March 4, 2025 07:04
@aBurmeseDev aBurmeseDev force-pushed the john-docs branch 4 times, most recently from 4013229 to 5bd831a Compare October 2, 2025 19:20
Copy link
Contributor

@kuhe kuhe left a comment

Choose a reason for hiding this comment

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

spacing

@aBurmeseDev aBurmeseDev force-pushed the john-docs branch 2 times, most recently from 8f13ac4 to e78907d Compare October 6, 2025 17:26
@kuhe
Copy link
Contributor

kuhe commented Oct 7, 2025

Please update smithy-typescript-protocol-test-codegen/model/my-local-model/main.smithy with a structure with deprecated fields both having and not having a deprecation message.

run make build generate-protocol-tests to see how the model is generated with your changes and commit those changes to your PR.

@aBurmeseDev aBurmeseDev requested a review from kuhe October 10, 2025 20:08
@kuhe kuhe changed the title fix(docs): improve deprecatedTrait with default description docs: improve deprecatedTrait with default description Oct 10, 2025
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.

Updating Doc Reference for deprecated command "InvokeAsyncCommand"

4 participants