docs: Clarify AWS::Serverless::SimpleTable.PrimaryKey Default Value
#1090
Conversation
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
In the prose of the description for `PrimaryKey`, the default key name is said to be "ID". In the examples and in the translator tests, the default value is "id".
keetonian
approved these changes
Aug 20, 2019
ShreyaGangishetty
approved these changes
Aug 20, 2019
|
Thanks so much! |
Closed
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.
In the prose of the description for
PrimaryKey, the default key name is said to be "ID". In the examples and in the translator tests, the default value is "id".May no one else be bitten by this.
Description of changes:
In short, I made the normative and descriptive texts match.
id" in the prose of the specification. This is a non-normative change, as the specified default is in the "Primary Key Object" section -- and it matches the normative value anyway.Typevalue. (String) This one is a normative change, but it's adding something to the specification text which was already specified.Description of how you validated changes:
I checked the values in the normative part of the specification and the output of the translator tests.
Checklist:
examples/2016-10-31By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.