Skip to content

chore(docs): improve idempotency documentation #1655

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

Merged
merged 1 commit into from
Aug 17, 2023

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Aug 17, 2023

Description of your changes

This PR brings minor improvements of the idempotency documentation. Here is the list of all the changes to make the review a bit easier:

  • add requirements to install the @aws-sdk/client-dynamodb package
  • add autonumber to sequence diagrams
  • remove “New to idempotency callout”
  • expiration should not be broken in the table
  • MakeIdempotent function wrapper: move callouts under the example to improve the reader flow
  • change Types tab to types.ts to make it consistent with the code
  • Choosing a payload subset for idempotency:
    • change deserialising callout to warning (it’s not a tip)
    • Don’t start with the callout, add it to text
    • Payment scenario is not a quote
    • the header example does not match the text (userid and product)
  • Lambda timeouts
    • clean up call outs and merge into text

Related issues, RFCs

Issue number: closes #1654

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@am29d am29d requested a review from a team August 17, 2023 12:03
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Aug 17, 2023
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Aug 17, 2023
@am29d am29d requested review from dreamorosi and removed request for a team August 17, 2023 12:03
@am29d am29d added the idempotency This item relates to the Idempotency Utility label Aug 17, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@am29d am29d self-assigned this Aug 17, 2023
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the work on these docs Alex, appreciate it.

@dreamorosi dreamorosi merged commit 92f3686 into main Aug 17, 2023
@dreamorosi dreamorosi deleted the docs-idempotency-improv branch August 17, 2023 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: idempotency docs improvements
2 participants