-
Notifications
You must be signed in to change notification settings - Fork 406
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(idempotency): fix misleading idempotent examples #661
docs(idempotency): fix misleading idempotent examples #661
Conversation
…elevant to multiple areas in Powertools
Codecov Report
@@ Coverage Diff @@
## develop #661 +/- ##
========================================
Coverage 99.97% 99.97%
========================================
Files 116 116
Lines 4846 4866 +20
Branches 265 267 +2
========================================
+ Hits 4845 4865 +20
Partials 1 1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this @walmsles! A few suggested changes inline - definitely a good improvement for the docs 😊
Apply suggestions from code review Co-authored-by: Tom McCarthy <[email protected]>
@cakepietoast - accepted review suggestions - documentation IS hard, thanks for the improvements 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Absolutely loved it!! Now that we're exposing JMESPath Functions in its own doc, I think it's fair we expose it for everyone to use with Since |
@heitorlessa also within Feature Toggles - although that doc references JMESPath site directly I noticed so within the scope of this change left that alone. Maybe want to re-align those docs too? |
…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: docs(idempotency): fix misleading idempotent examples (aws-powertools#661)
Issue #, if available: #657
Description of changes:
Updated Idempotency Payments API example and split out JMESPath Function section from Validation utility since also applicable to Idempotency utility. This split seems logical and updated references in both Validation and Idempotnecy documentation to suit.
No changes for Feature Flags documentation required (JMESPath is referenced but not built-in functions specifically)
Added warning around JSON API Idempotency in the Payments example explicitly calling ou the usage of event_key_jmespath which is essential for correct Idempotency for JSON API structures.
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
View rendered docs/utilities/idempotency.md
View rendered docs/utilities/jmespath_functions.md
View rendered docs/utilities/validation.md