Skip to content
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 query consistency params #170

Merged

Conversation

jimmyjames
Copy link
Contributor

@jimmyjames jimmyjames commented Jun 6, 2024

Description

Adds the consistency parameter to the following endpoints:

  • Check
  • List Users
  • List Objects
  • Expand
  • Read

The parameter is an enum with two values:

  • MINIMIZE_LATENCY - default, behavior is as-is today
  • HIGHER_CONSISTENCY - used to signal to the API to prefer higher consistency at the expense of potentially reduced performance

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • 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

@jimmyjames jimmyjames marked this pull request as ready for review June 6, 2024 02:21
@jimmyjames jimmyjames requested review from a team as code owners June 6, 2024 02:21
@jimmyjames jimmyjames requested a review from rhamzeh June 6, 2024 16:32
@jimmyjames jimmyjames merged commit 9d6a6fb into feat/stronger-consistency Jun 6, 2024
7 checks passed
@jimmyjames jimmyjames deleted the feat/add-query-consistency-params branch June 6, 2024 20:17
jimmyjames added a commit that referenced this pull request Jun 21, 2024
* feat: add consistency enum parameter for query APIs

* fix CI workflow branch name

* ignore enum suffix lint rule

* ignore enum val prefix lint warning

* fix up generated files

* docs formatting fix

* review feedback: update enum vals for future additions, update docs

* fix up docs clarification for all endpoints
ewanharris added a commit that referenced this pull request Jul 23, 2024
* setup feat/stronger-consistency branch

* feat: add query consistency params (#170)

* feat: add consistency enum parameter for query APIs

* fix CI workflow branch name

* ignore enum suffix lint rule

* ignore enum val prefix lint warning

* fix up generated files

* docs formatting fix

* review feedback: update enum vals for future additions, update docs

* fix up docs clarification for all endpoints

* feat: add consistency options to StreamedListObjects

* doc: correct consistency reference in doc string (#182)

* doc: correct consistency reference in doc string

* chore: remove dx from codeowners as we're moving off feature branch

* Merge main int feat/stronger-consistency-options (#184)

ci: don't pin version of buf (#181)

* ci: don't pin version of buf

Instead we will use the version that correlates to the action version

* chore(deps): update buf-setup-action version

* style: run buf format to make formatting changes

---------

Co-authored-by: Jim Anderson <[email protected]>
Co-authored-by: Raghd Hamzeh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants