feat: add scope of entityIds to lookup-entity api filter

[tolgaozen]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced new Entrance message type for better data modeling.
  • Added scope field to PermissionLookupEntityRequest and PermissionEntityFilterRequest for enhanced filtering capabilities.

• Improvements

  • Simplified withdrawal and viewing logic by directly accessing context data.
  • Enhanced pagination support in data querying methods.

• Bug Fixes

  • Removed deprecated QueryUniqueEntities method to streamline data retrieval processes.

• Documentation

  • Updated API documentation to reflect changes in data models and request structures.

• UI Changes

  • Removed "Weekday" option from dropdown in the MainLayout component to simplify user choices.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes encompass modifications to various YAML files and Go source files, primarily focusing on simplifying permission checks and enhancing API functionality. Key updates include the removal of parameters from rules, restructuring of API request formats to include a scope for entity filtering, and the introduction of new validation methods for the Entrance message. These alterations aim to streamline the logic for withdrawal permissions, improve the clarity of rules, and enhance the overall efficiency of entity filtering in the API.

Changes

File Path	Change Summary
assets/example-shapes/*.yaml	Modified withdrawal and viewing permissions to use context data instead of parameters.
docs/api-reference/*.json	Removed ContextAttribute, added scope property, and introduced StringArrayValue definition.
internal/engines/*.go	Refactored permission checking logic and introduced EntityFilter for handling entity relationships.
internal/schema/*.go	Added Entrance message and updated validation logic for various requests.
pkg/attribute/*.go	Simplified argument handling in CallOrAttributeToString function.
pkg/pb/base/v1/*.proto	Introduced new Entrance message and removed ContextAttribute.
pkg/schema/builder.go	Added support for a new context variable in rule definitions.
playground/src/layout/MainLayout.js	Removed "Weekday" option from dropdown menu.

Possibly related issues

• Add Scope of EntityIds to lookup-entity API Filter #1519: The changes introduce a scope parameter for entity filtering in API requests, aligning with the request to enhance the lookup-entity API filter.

Possibly related PRs

• fix: plan_cache_mode issue for RDS Proxy #1601: This PR focuses on PostgreSQL connection configuration, which is indirectly related but does not affect the main changes in permission logic.

Suggested reviewers

• No specific reviewers were suggested.

🐇 "In the code where rabbits hop,
Permissions change and never stop.
With scopes defined and rules refined,
A clearer path we now can find.
So let us cheer for all the tweaks,
In code we trust, our future speaks!" 🐇

---

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 generate interesting stats about this repository and render them as a table.
  -- @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.