docs(parameters): main docs for the utility #1215
Merged
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
pull-request-size
bot
added
the
size/XL
github-actions
bot
added
the
documentation
shdq
previously approved these changes
Jan 10, 2023
There was a problem hiding this comment.
Looks great!
I only find the section about the transformation a bit confusing, despite I worked with it and know how it works inside. We can improve it by explicitly writing that the result of the transformation is string. And another suggestion is to change the name of the argument to transformFrom: 'binary' in parameters before we released it.
docs/utilities/parameters.md
Outdated
|
|
||
| | Parameter | Default | Description | | ||
| | ------------- | ------- | --------------------------------------------------------------------------------------------- | | ||
| | **decrypt** | `false` | Will automatically decrypt the parameter. | |
There was a problem hiding this comment.
Maybe it is worth adding a reminder about IAM Permissions for decrypt. Like "required kms:Decrypt IAM permission"
Comment on lines
+6
to
+9
| /** | ||
| * Retrieve multiple values by performing a Query on the DynamoDB table. | ||
| * This returns a dict with the sort key attribute as dict key. | ||
| */ |
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.
Description of your changes
How to verify this change
Related issues, RFCs
Issue number: #1034
PR status
Is this ready for review?: NO
Is it a breaking change?: NO
Checklist
Breaking change checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.