docs: add guides for access control and named pipes - #205
Conversation
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Free Run ID: 📒 Files selected for processing (10)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR adds comprehensive documentation for two new WaveHouse features: Access Control (per-table/per-role authorization with JWT-driven evaluation, column and row-level security, and query limits) and Named Pipes (pre-defined parameterized SQL queries with role-based execution control). The sidebar navigation is updated to include both guides, existing documentation ordering is adjusted, and the architecture documentation is clarified to reflect NamedQuery parameter binding behavior. ChangesDocumentation: Access Control and Named Pipes
🎯 2 (Simple) | ⏱️ ~10 minutes Note 🎁 Summarized by CodeRabbit FreeYour organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login. Comment |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly expands the project's documentation by introducing detailed guides for Access Control and Named Pipes. These additions provide users with a clear understanding of how to secure their deployments, manage role-based access, and leverage parameterized SQL queries. Additionally, the sidebar has been reorganized to accommodate these new sections, ensuring a logical flow for developers and operators. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for 'Access Control' and 'Named Pipes' to the WaveHouse guides, updating the sidebar configuration and adjusting the ordering of existing documentation pages. It also updates the architecture documentation to clarify how named query pipes bind parameters by inlining escaped literal values. No review comments were provided, and there is no feedback to address.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
main's #205 access-control guide documented the pre-removal /v1/stream/sse + /v1/stream/ws routes and "WebSocket subscribers". This branch removes WS and collapses the streaming route to /v1/stream, so reconcile the merged-in guide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Summary
Adds two guides to the docs site (Guides section) covering how to set up policies, pipes, and roles — previously only the config knobs and raw endpoints were documented, with no task-oriented explanation of the model.
docs/src/content/docs/access-control.md): the full authorization model — roles (role_claim,default_role,admin_role), the policy document and every permission (column allow/deny, row-levelfilterwith JWT claim templating, insertcheck, aggregation controls,max_rows/max_execution_time_ms), where each rule is enforced across endpoints, policy management, and the file-bootstrap/KV lifecycle.docs/src/content/docs/pipes.md): pipe anatomy, declared and inline parameters and how values are bound/escaped,allowed_rolesauthorization, admin CRUD, execution/caching, and.sqldirectory bootstrap.sidebar.order.Test plan
None
Related Issues
N/A