feat: support usage of the consistency option #129
Merged
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
This is an initial attempt at introducing support for the experimental consistency option in the relevant APIs, this is supported on the following APIs:
And the following SDK methods
When introducing this option to the
OpenFGAClient
class, we decided that this option fits better in theoptions
object as opposed to therequest
object as it's more of an "override" choice akin to the existing model ID and store ID.So the usage looks like so
I think there is a question around the correct usage for
batchCheck
, in that instance should the consistency choice be per check or for the entirebatchCheck
, currently we have it for the entirebatchCheck
but personally I don't think this is ideal.References
Review Checklist
main