-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
feat: add retry strategy for api-rest category #8295
Conversation
path: 'items/1' | ||
path: 'items/1', | ||
retryStrategy: { | ||
strategy: 'no-retry' |
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.
i would also add comment to these on what default will be somethign like
strategy: 'no-retry' | |
strategy: 'no-retry' // This overrides default automatic retry strategy |
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.
I prefer adding a dedicated section in fetch-data page: https://docs.amplify.aws/react/build-a-backend/add-aws-services/rest-api/fetch-data/
The rest of pages should be more or less the same. If you want to make the retry strategy visible to every page, you can add one line to each code example like:
const restOperation = post({
apiName: 'myRestApi',
path: 'items',
options: {
body: {
message: 'Mow the lawn'
}
}
},
// Optional retryStrategy
});
Because we don't repleat all the options
in every REST API operation either, we only expand the usage in the fetch-data page.
Description of changes:
Add docs for retryStrategy in api-rest category
Document the changes made in this PR: aws-amplify/amplify-js#14303
Related GitHub issue #, if available:
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)
HTML:
<a href="https://docs.amplify.aws/">link</a>
When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.