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

chore: fix swagger docs for consistency pref #191

Merged
merged 8 commits into from
Sep 6, 2024

Conversation

jimmyjames
Copy link
Contributor

@jimmyjames jimmyjames commented Sep 3, 2024

Updates the documentation for the consistency parameter.

Description

  • Adds a description about the consistency endpoints to the Check and ListObjects API descriptions, and an example for Check.
  • Overrides the example usage showing UNSPECIFIED to show MINIMIZE_LATENCY instead.

References

Fixes #189

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

buf.yaml Outdated Show resolved Hide resolved
@jimmyjames jimmyjames force-pushed the fix/update-consistency-docs branch from 76cfe9b to a89e7b2 Compare September 4, 2024 15:41
@jimmyjames jimmyjames marked this pull request as ready for review September 4, 2024 17:04
@jimmyjames jimmyjames requested review from a team as code owners September 4, 2024 17:04
@jimmyjames jimmyjames force-pushed the fix/update-consistency-docs branch 6 times, most recently from 22d0df3 to 8af050e Compare September 5, 2024 16:13
rhamzeh
rhamzeh previously approved these changes Sep 5, 2024
@miparnisari miparnisari merged commit 102620e into main Sep 6, 2024
5 of 6 checks passed
@miparnisari miparnisari deleted the fix/update-consistency-docs branch September 6, 2024 20:30
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.

Update the documentation and examples to showcase the consistency flag
3 participants