docs: include valid values for S3 checksum options#10047
docs: include valid values for S3 checksum options#10047droppingbeans wants to merge 4 commits intoaws:developfrom
Conversation
Adds valid enum values to help text for --checksum-mode and --checksum-algorithm so generated documentation includes them. Fixes aws#10025
|
Hello @droppingbeans, thanks for making this PR. I have added some comment changes that inlines with our format. Let us know when changes are made, tested and if theres any issues. |
|
Thanks for the review! I’ve applied the suggested formatting changes and pushed an update to the PR. Please let me know if anything else is needed. |
| 'name': 'checksum-mode', 'choices': ['ENABLED'], | ||
| 'help_text': 'To retrieve the checksum, this mode must be enabled. If the object has a ' | ||
| 'checksum, it will be verified.' | ||
| 'checksum, it will be verified. Valid values: ENABLED.' |
There was a problem hiding this comment.
| 'checksum, it will be verified. Valid values: ENABLED.' | |
| 'checksum, it will be verified. Valid value: ENABLED.' |
| 'name': 'checksum-algorithm', 'choices': ['CRC64NVME', 'CRC32', 'SHA256', 'SHA1', 'CRC32C'], | ||
| 'help_text': 'Indicates the algorithm used to create the checksum for the object.' | ||
| 'help_text': 'Indicates the algorithm used to create the checksum for the object. ' | ||
| 'Valid values: CRC64NVME, CRC32, CRC32C, SHA1, and SHA256.' |
There was a problem hiding this comment.
| 'Valid values: CRC64NVME, CRC32, CRC32C, SHA1, and SHA256.' | |
| "Valid choices are: CRC64NVME | CRC32 | SHA256 | SHA1 | CRC32C. Defaults to 'CRC64NVME'." |
|
@droppingbeans, thanks for the reply. Apologies, looks like the request for change comment did not go through but now the changes needed should be visible now that inlines with our guidelines. Let us know when the changes are made. |
- Remove backticks from ENABLED value - Change 'is' to ':' for checksum-mode - Change 'values' to 'choices' for checksum-algorithm - Use pipe separators instead of commas - Add default value for checksum-algorithm
|
@adev-code Formatting changes applied as requested in commit 72e1f0e. Both help texts now follow the AWS CLI documentation guidelines. Ready for re-review. |
|
Tested it and appears on |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #10047 +/- ##
===========================================
+ Coverage 93.39% 93.40% +0.01%
===========================================
Files 210 210
Lines 17052 17139 +87
===========================================
+ Hits 15925 16009 +84
- Misses 1127 1130 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| 'help_text': 'Indicates the algorithm used to create the checksum for the object.' | ||
| 'help_text': ( | ||
| 'Indicates the algorithm used to create the checksum for the object. ' | ||
| 'Valid choices are: CRC64NVME | CRC32 | SHA256 | SHA1 | CRC32C. Defaults to \'CRC64NVME\'.' |
There was a problem hiding this comment.
Nit: looks like we use "Valid values" more frequently - storage class is the only other one with "choices". Let's try to improve the consistency and use "values".
| 'checksum, it will be verified.' | ||
| 'help_text': ( | ||
| 'To retrieve the checksum, this mode must be enabled. If the object has a ' | ||
| 'checksum, it will be verified. Valid value: ENABLED.' |
There was a problem hiding this comment.
It looks like the existing pattern for a single value is "ENABLED is the only valid value." See SSE_C for an example.
- Changed 'Valid value: ENABLED.' to 'ENABLED is the only valid value.' (following SSE_C pattern) - Changed 'Valid choices are:' to 'Valid values:' for consistency
4 participants
Adds valid enum values to help text for --checksum-mode and --checksum-algorithm so generated documentation includes them.
Fixes #10025
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.