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

Removing excluded users #171

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Removing excluded users #171

merged 2 commits into from
Jun 13, 2024

Conversation

willvedd
Copy link
Contributor

@willvedd willvedd commented Jun 12, 2024

Description

Removes excluded_users from the ListUsers API response. This feature was originally a well-intentioned way to communicate any negations that may exist on public-typed wildcard (e.g. user:*) as a means of being abundantly clear about what a user:* result entails. However, as we discover more possible situations where excluded users could arise, we realize that we were making a premature decision about the API. We fully intend to re-add excluded_users at some point in the future but may or may not be a flattened list as previously implemented.

Note: This is technically a breaking but is acceptable provided that the ListUsers API is still experimental.

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

@willvedd willvedd requested review from a team as code owners June 12, 2024 19:11
rhamzeh
rhamzeh previously approved these changes Jun 12, 2024
@willvedd willvedd merged commit f33cb24 into main Jun 13, 2024
6 of 7 checks passed
@willvedd willvedd deleted the list-users-remove-excluded-users branch June 13, 2024 18:45
github-merge-queue bot pushed a commit to openfga/dotnet-sdk that referenced this pull request Jun 14, 2024
## Description

Removes `excluded_users` from the response of all SDKs as it was removed
from OpenFGA with openfga/api#171.

This feature was originally a well-intentioned way to communicate any
negations that may exist on public-typed wildcard (e.g. `user:*`) as a
means of being abundantly clear about what a `user:*` result entails.
However, as we discover more possible situations where excluded users
could arise, we realize that we were making a premature decision about
the API. We fully intend to re-add excluded_users at some point in the
future but may or may not be a flattened list as previously implemented.

**Please note:**
- This is technically a breaking but is acceptable provided that the
ListUsers API is still experimental

## References

- Related PR in openfga/sdk-generator:
openfga/sdk-generator#377
- Related PR in openfga/api: openfga/api#171

## 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
github-merge-queue bot pushed a commit to openfga/dotnet-sdk that referenced this pull request Jun 17, 2024
## Description

```
- chore!: remove excluded users from ListUsers response

BREAKING CHANGE:

This version removes the `ExcludedUsers` field from the `ListUsersResponse` and `ClientListUsersResponse` classes,
for more details see the [associated API change](openfga/api#171).
```

## References

## 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
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

3 participants