Add --show-traits to select command #1692
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The --show-traits option will include the serialize value of specific traits for each shape matched by the --select command. The output format is the same as the format used with --vars, but also included in the output is a 'traits' property that contains a map of trait shape IDs to trait values. --show-traits is a comma separated list of trait shape IDs, where omitting a namespace assumes the trait is in the prelude (e.g., 'required' is the same as 'smithy.api#required'). Matches are not required to have the traits defined in --show-traits, so if that is the desired filtering, the selector provided in --selector needs to ensure each shape has the required traits. This option can be useful to answer questions like: "what are all the HTTP headers used in my service?" or "what are the default values of every shape?"
AndrewFossAWS
approved these changes
Mar 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The --show-traits option will include the serialize value of specific traits for each shape matched by the --select command. The output format is the same as the format used with --vars, but also included in the output is a 'traits' property that contains a map of trait shape IDs to trait values. --show-traits is a comma separated list of trait shape IDs, where omitting a namespace assumes the trait is in the prelude (e.g., 'required' is the same as 'smithy.api#required'). Matches are not required to have the traits defined in --show-traits, so if that is the desired filtering, the selector provided in --selector needs to ensure each shape has the required traits.
This option can be useful to answer questions like: "what are all the HTTP headers used in my service?" or "what are the default values of every shape?"
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.