Updating docs on users in Connect #15740
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Warning Rate limit exceeded@dannyroosevelt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 42 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThe changes update Pipedream’s documentation on user account management and workflow execution. The updated content introduces a new “Connecting multiple accounts” section, clarifies that only the most recently created account is used when multiple accounts exist, and expands instructions for deleting accounts via API and UI. Additionally, a new section in the workflows documentation details the limitation of using multiple accounts for the same app during a single execution. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant E as Workflow Engine
participant A as Account Manager
U->>E: Trigger workflow with external_user_id
E->>A: Request connected accounts for user/app
A-->>E: Return list of accounts (multiple)
E->>A: Select most recently created account
A-->>E: Send selected account details
E->>E: Execute workflow using selected account
E-->>U: Return workflow result
Possibly related PRs
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
docs-v2/pages/connect/managed-auth/users.mdx (3)
13-18: New "Connecting multiple accounts" section is a valuable addition
This section effectively informs users that they can connect multiple accounts for various apps—even multiple accounts for the same app—and explains how to filter account information via the API. Consider a minor punctuation tweak, for example using "e.g.," instead of "e.g" to further polish the text.
23-26: Consider verb choice in the "Deleting accounts" section
The text states, "You have several options for removing access in Pipedream…" While the meaning is clear, consider whether a stronger or more precise verb (such as "revoke" or "delete") might more effectively align with internal terminology and set clearer expectations for the user.🧰 Tools
🪛 LanguageTool
[style] ~25-~25: Consider using a different verb to strengthen your wording.
Context: ... accounts You have several options for removing access in Pipedream, depending on wheth...(REMOVE_REVOKE)
31-36: UI deletion steps are clear, but consider rephrasing the confirmation prompt
The instructions under "From the UI" are easy to understand. However, the step "6. Confirm the deletion when prompted" is phrased similarly to other parts of our documentation. Rewording it—for example: "A confirmation prompt will appear; please proceed accordingly"—could add some variety and clarity.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...button next to the specific account you want to remove 6. Confirm the deletion when pro...(REP_WANT_TO_VB)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (2)
docs-v2/pages/connect/managed-auth/users.mdx(1 hunks)docs-v2/pages/connect/workflows.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/managed-auth/users.mdx
[style] ~25-~25: Consider using a different verb to strengthen your wording.
Context: ... accounts You have several options for removing access in Pipedream, depending on wheth...
(REMOVE_REVOKE)
[style] ~36-~36: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...button next to the specific account you want to remove 6. Confirm the deletion when pro...
(REP_WANT_TO_VB)
🪛 GitHub Actions: Validate MDX Links
docs-v2/pages/connect/managed-auth/users.mdx
[error] 74-74: Broken link: /connect/api/#delete-user (anchor not found)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: pnpm publish
- GitHub Check: Lint Code Base
🔇 Additional comments (4)
docs-v2/pages/connect/workflows.mdx (1)
415-417: New section clarifying multiple account usage added
The section "#### Cannot use multiple accounts for the same app during a single execution" succinctly explains that when multiple accounts exist for the same app, Pipedream will use the most recently created account. This clear clarification helps set the right user expectations regarding workflow execution.docs-v2/pages/connect/managed-auth/users.mdx (3)
19-22: Clear callout warning regarding single account usage in workflows
The warning callout is well written and clearly states that only one account per app is used during workflow execution. The link to additional documentation on managing connected accounts further supports user understanding.
41-50: API deletion instructions for individual connected accounts are clear
The steps and associated code snippet for deleting a connected account via the API are concise and informative, providing users with a straightforward method to remove specific accounts.
51-65: User deletion instructions are comprehensive and clear
The "Deleting users" section is detailed, covering both UI and API methods. The callout effectively warns that deletion is permanent, ensuring that users are well informed before proceeding.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs-v2/pages/connect/managed-auth/users.mdx (2)
23-30: Suggested Refinement in Describing Account Deletion OptionsThe "Deleting accounts" section is well organized. However, on line 25, consider using a stronger, more active verb—such as "revoke" or "disable"—instead of "removing access" to enhance clarity and maintain a consistent tone throughout the document.
🧰 Tools
🪛 LanguageTool
[style] ~25-~25: Consider using a different verb to strengthen your wording.
Context: ... accounts You have several options for removing access in Pipedream, depending on wheth...(REMOVE_REVOKE)
32-37: UI Instruction Phrasing ConsistencyThe step-by-step instructions for deleting individual connected accounts in the UI are clear. Note that on line 36, the phrasing ("the specific account you want to remove") appears similar to language used nearby. Consider rephrasing this step to vary the wording for improved readability.
🧰 Tools
🪛 LanguageTool
[style] ~36-~36: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...button next to the specific account you want to remove 6. Confirm the deletion when pro...(REP_WANT_TO_VB)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs-v2/pages/connect/managed-auth/users.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/managed-auth/users.mdx
[style] ~25-~25: Consider using a different verb to strengthen your wording.
Context: ... accounts You have several options for removing access in Pipedream, depending on wheth...
(REMOVE_REVOKE)
[style] ~36-~36: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...button next to the specific account you want to remove 6. Confirm the deletion when pro...
(REP_WANT_TO_VB)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
🔇 Additional comments (6)
docs-v2/pages/connect/managed-auth/users.mdx (6)
13-18: Clear Documentation on Multiple Connected AccountsThe new "Connecting multiple accounts" section improves the clarity of how users can manage multiple accounts. Please verify that the API anchor
(/connect/api/#accounts)is correct and that the phrasing ("and / or") is consistent; consider using "or" for cleaner readability.
19-21: Effective Callout for Workflow Account SelectionThe callout clearly states that only one account (the most recently created) is used when multiple accounts exist for a given app. Ensure that the link provided (here) correctly directs users to the intended workflow documentation.
41-47: Clear API Deletion Example for Connected AccountsThe cURL command example for deleting connected accounts is straightforward. Double-check that placeholders such as
{project_id},{account_id}, and{access_token}are explained in accompanying documentation so that users can easily identify where to substitute their values.
49-49: Verify API Reference Anchor in Deletion SectionPlease confirm that the anchor
/connect/api/#delete-connected-accountused in the API reference is valid. This update seems to address previous issues with broken links.
51-64: Well-Structured User Deletion SectionThe documentation section for deleting users—including options via UI and API—is clear and detailed. The callout emphasizing the permanence of this action is appropriately highlighted.
66-74: Validation of API Example for User DeletionThe API example for deleting a user, along with the reference link
[API reference](/connect/api/#delete-an-end-user), is presented clearly. Please verify that the anchor/connect/api/#delete-an-end-userexists and directs to the correct section in your API documentation.
WHY
Summary by CodeRabbit