Support for array of permissions in lookup entity v2

[ankitsheoran1]

Summary by CodeRabbit

• New Features

  • Introduced two new API endpoints for permissions:
    • POST /v1/tenants/{tenant_id}/permissions/lookup-entities
    • POST /v1/tenants/{tenant_id}/permissions/lookup-entities-stream
  • Enhanced validation for permission-related requests and responses.

• Bug Fixes

  • Improved handling of permissions in integration tests for various services.

• Documentation

  • Updated API documentation to reflect new endpoints and request/response structures.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request introduce significant enhancements to the Permify API, particularly in the area of permissions management. Two new endpoints, /lookup-entities and /lookup-entities-stream, have been added to facilitate entity lookups based on permissions. Additionally, several modifications have been made to the integration tests and internal engines to support these new functionalities. The validation logic for requests and responses has also been updated to ensure compliance with specified constraints.

Changes

File Path	Change Summary
docs/api-reference/apidocs.swagger.json	Added new endpoints: POST /v1/tenants/{tenant_id}/permissions/lookup-entities and lookup-entities-stream. Updated definitions for PermissionsLookupEntityResponse, PermissionsLookupEntityStreamResponse, LookupEntitiesBody, and LookupEntitiesStreamBody.
integration-test/usecases/facebook_groups_test.go, .../google_docs_test.go, .../notion_test.go	Updated permissionClient.LookupEntity method to accept multiple permissions and modified response handling in tests.
internal/engines/bulk.go, .../entityFilter.go, .../lookup.go	Enhanced BulkChecker, EntityFilter, and LookupEngine classes with new parameters and methods for handling permissions.
internal/invoke/invoke.go, internal/servers/permissionServer.go	Added LookupEntities and LookupEntitiesStream methods to the Invoke interface and PermissionServer.
pkg/pb/base/v1/service.pb.validate.go, .../health.pb.validate.go	Introduced validation logic for PermissionsLookupEntityRequest, PermissionsLookupEntityResponse, and health check messages.

Possibly related PRs

• #1488: This PR updates API requests and client-side calls, including modifications to the apidocs.swagger.json file, which is directly related to the changes made in the main PR regarding the API documentation for new endpoints and response structures.
• #1632: This PR introduces a new health check protocol and updates the API documentation accordingly, which aligns with the changes in the main PR that also involve modifications to the health-related API documentation.
• #1642: This PR reverts the health API changes, including the removal of health check endpoints and related documentation, which directly relates to the changes made in the main PR regarding the health check functionality in the API documentation.

Suggested reviewers

• tolgaOzen

Poem

🐰 In the realm of permissions, we hop with cheer,
New endpoints are here, bringing entities near.
With validations in place, our checks are so bright,
A leap towards clarity, in the API's light!
So let’s celebrate changes, both big and small,
For the power of permissions, we now can enthrall! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[ucatbas]

Hey @ankitsheoran1, Thank you for updating the PR and rebasing it to latest version. There are some issues with naming and BulkChecker method. I have another PR affecting it. I wanted to make sure I highlight the other PR related to the bulk-checker. Here’s the link: feat: bulk permission check api is added.