docs: update service docs for connect_as#360
Conversation
Replace all references to auto-created svc_* service accounts with the connect_as credential model. - index.md: update credential language throughout - managing.md: add database_users + connect_as to MCP example; remove stale credential-revocation language from removal section - mcp.md: update allow_writes description to remove svc_* user references; add database_users + connect_as to all examples
Up to standards ✅🟢 Issues
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughDocs revised to replace automatically-managed per-instance DB credentials with explicit, user-specified database users referenced by Changes
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/services/managing.md (1)
136-167:⚠️ Potential issue | 🟡 MinorUpdate example is incomplete and inconsistent with add examples.
The "Updating a Service" example is missing the
database_usersarray and theconnect_asfield in the service spec. Since line 133 states that theservicesarray is declarative and replaces the complete list, this example should include these fields for consistency with the "Adding a Service" examples and to avoid user confusion.📝 Suggested addition
Add the
database_usersarray andconnect_asfield to match the structure shown in the "Adding a Service" examples:curl -X POST http://host-1:3000/v1/databases/example \ -H 'Content-Type: application/json' \ --data '{ "spec": { "database_name": "example", "nodes": [ { "name": "n1", "host_ids": ["host-1"] } ], + "database_users": [ + { + "username": "mcp_user", + "password": "changeme", + "db_owner": true, + "attributes": ["LOGIN"] + } + ], "services": [ { "service_id": "mcp-server", "service_type": "mcp", "version": "latest", "host_ids": ["host-1"], "port": 8080, + "connect_as": "mcp_user", "config": {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/services/managing.md` around lines 136 - 167, The update example omits required fields in the service spec; modify the curl payload so the services array in the POST body includes the same structure as the "Adding a Service" examples by adding a database_users array and the connect_as field to the mcp service object (the "services" array, the service object with "service_id":"mcp-server" and its "config"), ensuring the declarative replace behavior is clear by providing the full service entry including database_users and connect_as values.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/services/managing.md`:
- Around line 136-167: The update example omits required fields in the service
spec; modify the curl payload so the services array in the POST body includes
the same structure as the "Adding a Service" examples by adding a database_users
array and the connect_as field to the mcp service object (the "services" array,
the service object with "service_id":"mcp-server" and its "config"), ensuring
the declarative replace behavior is clear by providing the full service entry
including database_users and connect_as values.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e955abe3-8457-4a02-8660-e8b69de87a00
📒 Files selected for processing (3)
docs/services/index.mddocs/services/managing.mddocs/services/mcp.md
Summary
svc_{service_id}_roandsvc_{service_id}_rwservice accounts from the services docsallow_writesdescription inmcp.mdto describe server-side write enforcement and node routing rather than which database user is selecteddatabase_usersandconnect_asfields to all MCP service examples (mcp.mdandmanaging.md)index.mdandmcp.mdPLAT-557