Revise default value design doc to match recent updates #1412
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
srchase
approved these changes
Sep 19, 2022
gosar
reviewed
Sep 19, 2022
| @@ -277,6 +320,11 @@ The following shapes have restrictions on their default values: | |||
|
|
|||
| ### Updating default values | |||
|
|
|||
| The default value of a member MAY be changed. The default value of a root-level | |||
There was a problem hiding this comment.
It is a SHOULD NOT below. The MAY sentence can be removed here.
| shape MUST NOT be changed since that would break any shape that refers to | ||
| the shape, and could break other models that refer to a shape defined in a | ||
| shared model. | ||
|
|
||
| The default value of a member SHOULD NOT be changed. However, it MAY be |
There was a problem hiding this comment.
It is implied that this applies only when the member has a default without the target root level shape having a default, but maybe worth calling it out.
The default value of a member (that targets a shape without a default value) SHOULD NOT be changed.
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.
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.