feat: add support for list of permissions in lookup-entity

[ankitsheoran1]

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced API to support multiple permissions with new endpoints for entity lookups and streaming responses.
  • Introduced structured representations for entity identifiers and request bodies, improving clarity in API interactions.
  • Added functionality for concurrent permission checks, enhancing performance and flexibility.

• Bug Fixes

  • Improved validation logic for permissions, ensuring compliance with new constraints.

• Documentation

  • Updated API documentation to reflect the new endpoints and changes in permissions and entity handling.

• Tests

  • Expanded tests to validate multiple permissions and their associated entity IDs, enhancing test coverage.

[vercel[bot]]

Someone is attempting to deploy a commit to the permify Team on Vercel.

A member of the Team first needs to authorize it.

[ucatbas]

Hi @ankitsheoran1, thank your for you contribution! I have updated the last case you added for linked schemas and now it is passing.

[coderabbitai[bot]]

Walkthrough

The changes introduce new endpoints and modify existing ones in the Permify API, significantly enhancing the handling of permissions. Two new endpoints, /v1/tenants/{tenant_id}/permissions/lookup-entities and /v1/tenants/{tenant_id}/permissions/lookup-entities-stream, allow for both synchronous and streaming entity lookups based on specified permissions. The existing endpoint for entity lookup has been updated to provide a more detailed response. Additionally, new data structures for requests and responses have been added to support these functionalities, along with enhanced validation logic for robust error handling.

Changes

Files	Change Summary
docs/api-reference/apidocs.swagger.json, docs/api-reference/openapiv2/apidocs.swagger.json	Added new endpoints for entity lookup and streaming; updated existing endpoint responses; introduced new request and response structures for permissions.
pkg/pb/base/v1/service.pb.validate.go	Added new validation functions and structures for handling permissions lookup requests and responses; introduced validation logic for new types.
proto/base/v1/service.proto	Introduced new RPC methods for batch and streaming entity lookups; modified existing method signatures to accommodate new request and response message types.
pkg/pb/base/v1/health.pb.validate.go	Added validation logic for HealthCheckRequest and HealthCheckResponse messages; introduced new error handling types for validation failures.

Possibly related PRs

• #1488: This PR updates the API requests and client-side calls, including the LookupEntity and LookupEntityStream methods, which are directly related to the new endpoints introduced in the main PR.
• #1632: This PR adds health check functionality, including new request and response types that may interact with the permission endpoints, enhancing the overall API structure.
• #1642: This PR reverts the health check API changes, which were part of the previous enhancements, indicating a direct relationship with the health-related modifications in the main PR.

Suggested reviewers

• tolgaOzen

🐰 In the meadow where bunnies hop,
Permissions now can grow and pop!
With entities linked, so neat and bright,
Our API dances in the moonlight.
A structure so clear, a joy to see,
Hooray for changes, oh so free! 🌼

---

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]

Commit history is a bit confusing as I had to pass all changes to master in another branch first to preserve @ankitsheoran1's contributions. Please squash merge once everything is ready.