docs: include retry information in the readme for SDKs#333
Merged
Conversation
ewanharris
force-pushed
the
chore/document-retries
branch
2 times, most recently
from
094aaa1 to
414ba17
Compare
4 tasks
Member
Author
|
Heh, I guess this would need to be conditionally rendered in the readme of SDKs that aren't yet compliant with retries |
ewanharris
force-pushed
the
chore/document-retries
branch
from
414ba17 to
d885627
Compare
ewanharris
force-pushed
the
chore/document-retries
branch
from
d885627 to
b948b03
Compare
ewanharris
force-pushed
the
chore/document-retries
branch
from
b948b03 to
e07ce50
Compare
rhamzeh
reviewed
Mar 28, 2024
Contributor
|
👋 I've added I realize the wording is quite different, but I thought I'd propose an alternative approach. I'll be happy to update it if the other approach is preferred, of course. 😄 |
This was referenced Apr 2, 2024
Member
Author
|
@evansims that sounds much better thank you! I'll apply the edits to the other SDKs tomorrow alongside the changes to source the values from the config! |
rhamzeh
reviewed
Apr 3, 2024
ewanharris
changed the title
rhamzeh
approved these changes
Apr 3, 2024
github-merge-queue bot
pushed a commit
to openfga/dotnet-sdk
that referenced
this pull request
Apr 3, 2024
## Description Adds retries onto the client credential request. ## References Generated from openfga/sdk-generator/pull/333 Closes #24 ## Review Checklist - [x] I have clicked on ["allow edits by maintainers"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). - [] I have added documentation for new/changed functionality in this PR or in a PR to [openfga.dev](https://github.com/openfga/openfga.dev) [Provide a link to any relevant PRs in the references section above] - [x] The correct base branch is being used, if not `main` - [ ] I have added tests to validate that the change in functionality is working as expected
This was referenced Apr 4, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Adds a process for documenting the retry strategy of each SDK in the readme following the other SDK specific readme pieces by introducing a
README_retries.mustachefile that will be rendered into the readme.doActionfeature (e.g track number of requests and change response depending on request count), because any request after the first fails for reason my limited Java knowledge can’t debug. From what I can tell it's only built to handle one request per URL.Given that last one, I'm putting this into draft to prevent any merge.
References
#320
Review Checklist
main