Conversation
JordonPhillips
requested changes
Mar 26, 2020
smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude-traits.smithy
Outdated
Show resolved
Hide resolved
bb9ebae to
d60096d
Compare
JordonPhillips
requested changes
Mar 26, 2020
smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude-traits.smithy
Outdated
Show resolved
Hide resolved
The enum trait is currently a map of enum value to the enum definition. This means that models often look like this: ``` @enum(foo: {}, bar: {}) string MyString ``` Ideally, a name and documentation are provided too: ``` @enum( foo: {name: "FOO", documentation: "foo docs..."}, bar: {name: "BAR", documentation: "bar docs..."}) ``` However, the difference between the key and "name" has resulted in confusion as to which is which. This is caused by a couple things: 1. The key doesn't tell you what it defines. You have to know that the the key defines the value of the enum to make sense of the trait. 2. The key has to be quoted if it deviates from the allows ABNF for node object keys. This has also led to confusion. Although this is a breaking change, using a list of structures where everything has a name will result in models that are easier to understand, and hopefully modelers will more often include properties like `name` and `documentation`.
d60096d to
baaed3a
Compare
JordonPhillips
approved these changes
Mar 27, 2020
Merged
This file contains hidden or 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
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 enum trait is currently a map of enum value to the enum definition.
This means that models often look like this:
Ideally, a name and documentation are provided too:
However, the difference between the key and "name" has resulted in
confusion as to which is which. This is caused by a couple things:
the key defines the value of the enum to make sense of the trait.
object keys. This has also led to confusion.
Although this is a breaking change, using a list of structures where
everything has a name will result in models that are easier to
understand, and hopefully modelers will more often include properties
like
nameanddocumentation.This now looks like:
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.