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.

Sign up for GitHub

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

Jump to bottom

Add list users snippet, concept and testing #732

Merged
merged 12 commits into from
May 9, 2024
Merged

Add list users snippet, concept and testing #732

merged 12 commits into from
May 9, 2024

Conversation

ewanharris
Copy link
Member

@ewanharris ewanharris commented May 2, 2024 •
edited
Loading

Description

  • 30aaf25 - Adds the snippet viewer for list users, the python implementation is currently a guess as it's not implemented
  • f6dba22 - Adds docs for list users to the concepts page, the testing guide, and a perform list users page. The latter two include a warning banner that states the experimental nature and link to the announcement.

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 2, 2024 •
edited
Loading

PR Preview Action v1.4.7
🚀 Deployed preview to https://openfga.github.io/openfga.dev/pr-preview/pr-732/
on branch gh-pages at 2024-05-09 08:58 UTC

@ewanharris ewanharris force-pushed the feat/list-users-snippet-and-docs branch from 7d56b04 to e55bfef Compare May 2, 2024 11:51
willvedd
willvedd requested changes May 2, 2024
View reviewed changes
Copy link
Contributor

@willvedd willvedd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for doing this. Just a couple things I noticed with an initial pass.

docs/content/concepts.mdx Outdated Show resolved Hide resolved
docs/content/concepts.mdx Outdated Show resolved Hide resolved
docs/content/getting-started/perform-list-users.mdx Outdated Show resolved Hide resolved
docs/content/getting-started/perform-list-users.mdx Outdated Show resolved Hide resolved
docs/content/getting-started/perform-list-users.mdx Outdated Show resolved Hide resolved
@miparnisari miparnisari mentioned this pull request May 6, 2024
Merged
@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 7, 2024 •
edited
Loading

Minder Vulnerability Report ✅

Minder analyzed this PR and found no vulnerable dependencies.

Vulnerability scan of bd63b1a6:

  • 🐞 vulnerable packages: 0
  • 🛠 fixes available for: 0

@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 7, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -

@ewanharris ewanharris force-pushed the feat/list-users-snippet-and-docs branch from 248e75e to c446273 Compare May 7, 2024 09:55
@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 7, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -
npm @openfga/sdk 4.8 No alternative found -

@ewanharris ewanharris requested a review from willvedd May 7, 2024 09:56
@ewanharris ewanharris marked this pull request as ready for review May 7, 2024 09:56
@ewanharris ewanharris requested review from a team as code owners May 7, 2024 09:56
rhamzeh
rhamzeh requested changes May 7, 2024
View reviewed changes
docs/content/concepts.mdx Outdated Show resolved Hide resolved
docs/content/concepts.mdx Outdated Show resolved Hide resolved
docs/content/concepts.mdx Outdated Show resolved Hide resolved
docs/content/getting-started/perform-list-users.mdx Outdated Show resolved Hide resolved
docs/content/getting-started/perform-list-users.mdx Outdated Show resolved Hide resolved
src/components/Docs/SnippetViewer/ListUsersRequestViewer.tsx Outdated Show resolved Hide resolved
src/components/Docs/SnippetViewer/ListUsersRequestViewer.tsx Outdated Show resolved Hide resolved
src/components/Docs/SnippetViewer/ListUsersRequestViewer.tsx Outdated Show resolved Hide resolved
src/components/Docs/SnippetViewer/ListUsersRequestViewer.tsx Outdated Show resolved Hide resolved
src/components/Docs/SnippetViewer/ListUsersRequestViewer.tsx Outdated Show resolved Hide resolved
@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 7, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -
npm @openfga/sdk 4.8 No alternative found -

@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 8, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -
npm @openfga/sdk 4.8 No alternative found -

@ewanharris ewanharris requested a review from rhamzeh May 8, 2024 08:35
@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 8, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -
npm @openfga/sdk 4.8 No alternative found -

@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 8, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -

willvedd
willvedd reviewed May 8, 2024
View reviewed changes
Copy link
Contributor

@willvedd willvedd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two small suggestions but otherwise I think it looks good!

docs/content/modeling/testing-models.mdx Outdated Show resolved Hide resolved
docs/content/modeling/testing-models.mdx Outdated Show resolved Hide resolved
@ewanharris ewanharris requested a review from willvedd May 8, 2024 13:19
@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 8, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -
npm @openfga/sdk 4.8 No alternative found -

@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 8, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -
npm @openfga/sdk 4.8 No alternative found -

willvedd
willvedd previously approved these changes May 8, 2024
View reviewed changes
Copy link
Contributor

@willvedd willvedd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small point about the correct wildcard terminology but otherwise looks good to me. Thank you!

@stacklok-cloud Stacklok Cloud
Copy link
Contributor

stacklok-cloud bot commented May 9, 2024

Summary of packages with low scores

Minder detected that this PR is adding dependencies whose score is lower than the threshold configured with
Minder profiles. Below is a summary of the packages with low scores and their alternatives.

Pkg Name Score Alternative Name Alternative Score
npm @openfga/sdk 4.8 No alternative found -
npm @openfga/sdk 4.8 No alternative found -

@ewanharris ewanharris enabled auto-merge (squash) May 9, 2024 09:59
@ewanharris ewanharris requested a review from willvedd May 9, 2024 09:59
@ewanharris ewanharris merged commit a004edd into main May 9, 2024
12 checks passed
@ewanharris ewanharris deleted the feat/list-users-snippet-and-docs branch May 9, 2024 11:45
@willvedd willvedd mentioned this pull request May 10, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@willvedd willvedd willvedd approved these changes

@rhamzeh rhamzeh rhamzeh approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ewanharris @rhamzeh @willvedd