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

Update API ref #448

Merged
merged 3 commits into from
Nov 12, 2024
Merged

Update API ref #448

merged 3 commits into from
Nov 12, 2024

Conversation

ewanharris
Copy link
Member

@ewanharris ewanharris commented Nov 6, 2024

Description

This is based on #446 as it handles some changes to help with the validation, once that is merged I will update to remove those commits.

This updates to the latest version of openfga/api that is included in OpenFGA v1.7.0, with the
following interesting changes included. These are mostly changes to the underlying models and will not require
any changes to the individual codebases aside from potential test changes.

  • Adds support for contextual tuples on the assertions API, needs OpenFGAClient updating to support this which is tracked in Support contextual tuples an assertion in OpenFGAClient #449
  • Changes min/max page size for read api, should not impact any SDK other than Python
  • Adds a new response type for 403 responses and changes the existing cancelled response
  • Changes min/max for contextual_tuples, should not impact any SDK other than Python
  • Bumps contextual tuples to 100, , should not impact any SDK other than Python

I have updated any SDKs that had issues running tests after this (Java and Python) but no other work to SDKs has been handled (such as updating OpenFGAClient to support contextual tuples in assertions)

References

I started the Python update in this branch

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

If you haven't done so yet, we would appreciate it if you could star the OpenFGA repository. :)
It differs from other endpoints in that it isn't an object but just an array directly

This updates to the latest version of openfga/api that is included in OpenFGA v1.7.0, with the
following interesting changes included. These are mostly changes to the underlying models and will not require
any changes to the individual codebases aside from potential test changes.

- Adds support for contextual tuples on the assertions API, needs OpenFGAClient updating to support this
- Changes min/max page size for read api, should not impact any SDK other than Python
- Adds a new response type for 403 responses and changes the existing cancelled response
- Changes min/max for contextual_tuples, should not impact any SDK other than Python
- Bumps contextual tuples to 100, , should not impact any SDK other than Python
@ewanharris ewanharris marked this pull request as ready for review November 12, 2024 10:42
@ewanharris ewanharris requested a review from a team as a code owner November 12, 2024 10:42
@ewanharris ewanharris added this pull request to the merge queue Nov 12, 2024
Merged via the queue into main with commit e4bfdff Nov 12, 2024
14 checks passed
@ewanharris ewanharris deleted the chore/update-api-ref branch November 12, 2024 16:00
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.

2 participants