Update polymorphism.md

[bbozzay]

When I initially read this, I thought that specifying the 'delegate' kind was the way to opt in to the feature. If someone is as careless as I was, they might not realize they are turning off authorization policies by only specifying one kind. I think this change will help the reader realize that each kind has to be specified

Summary by CodeRabbit

• Documentation
  • Updated the polymorphism.md guide to clarify polymorphic relations in Prisma and ZenStack.
  • Expanded sections on implementation, usage, and TypeScript types for better understanding.
  • Discussed limitations of the current polymorphic model implementation.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
zenstack-new-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 3, 2024 6:04am

[coderabbitai]

Walkthrough

The pull request updates the polymorphism.md document to provide a more comprehensive explanation of polymorphic relations in Prisma and their implementation using ZenStack. It expands on the challenges of modeling these relations, introduces a section on ZenStack's enhancements to PrismaClient, and elaborates on modeling, querying, and managing access policies for polymorphic relations. The document also discusses polymorphic TypeScript types and their differences from standard Prisma types, while noting the limitations of the current implementation.

Changes

File	Change Summary
docs/guides/polymorphism.md	Expanded introduction on polymorphic relations, added ZenStack implementation details, enhanced usage examples, and discussed limitations of the current implementation.

Possibly related PRs

• docs: add description for polymorphic ts typing #315: The changes in this PR also focus on enhancing the documentation for polymorphic TypeScript types, which directly relates to the updates made in the main PR regarding polymorphic relations and TypeScript types generated by ZenStack.

---

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/guides/polymorphism.md (1)

131-131: Approved: Good clarification on specifying multiple kinds

The addition of the 'policy' kind alongside 'delegate' in the enhance function call is a good clarification. It addresses the PR objective of preventing misunderstanding about specifying only one kind and potentially disabling authorization policies unintentionally.

To further improve the documentation:

Consider adding a brief explanation after this code block to emphasize why specifying both 'delegate' and 'policy' kinds is important. For example:

Note: Specifying both 'delegate' and 'policy' kinds ensures that polymorphic relations and authorization policies are both enabled. Omitting either kind could lead to unexpected behavior in your application.

This additional note would reinforce the importance of explicitly specifying each required kind.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 27a9a03 and e1a4613.

📒 Files selected for processing (1)

• docs/guides/polymorphism.md (1 hunks)

[ymc9]

Thank you for the fix @bbozzay ! Merging it now.