Clarifying OAuth client usage for accounts API

[dannyroosevelt]

WHY

Summary by CodeRabbit

• Documentation
  • Simplified and clarified the explanation for retrieving credentials of connected accounts for OAuth apps, removing environment-specific details and focusing on the requirement for custom OAuth clients.

[vercel]

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

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		May 1, 2025 6:50pm
pipedream-docs	⬜️ Ignored (Inspect)			May 1, 2025 6:50pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			May 1, 2025 6:50pm

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The documentation for the API connection process was revised to clarify the requirements for retrieving credentials of connected accounts for OAuth applications. The update removes references to environment-specific behavior and the use of Pipedream's OAuth clients, instead stating simply that credentials can be retrieved only if a custom OAuth client is used. This clarification was made in two locations within the documentation.

Changes

File(s)	Change Summary
docs-v2/pages/connect/api.mdx	Simplified and clarified documentation regarding retrieval of credentials for OAuth connected accounts. Removed environment-specific distinctions and references to Pipedream's OAuth clients.

Suggested reviewers

• adolfo-pd

Poem

A rabbit with docs in its paw,
Hopped through the OAuth law.
No more confusion, no tangled delight—
Custom clients now make it right!
With clarity shining, the docs are anew,
Easy to follow, for all of you.
🐇✨

---

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.

❤️ 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 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

🧹 Nitpick comments (2)

docs-v2/pages/connect/api.mdx (2)

431-432: Remove environment context and clarify custom OAuth client requirement
The updated callout correctly removes the development/production distinction and focuses solely on the requirement that OAuth apps must use a custom OAuth client, aligning perfectly with the PR objectives.

For consistency across the docs, consider unifying the link text:

- To retrieve credentials for a connected account for **OAuth** apps (Slack, Google Sheets, etc), the connected account must be using [your own OAuth client](/connect/managed-auth/oauth-clients/#using-a-custom-oauth-client).
+ To retrieve credentials for a connected account for **OAuth** apps (Slack, Google Sheets, etc), the connected account must use [a custom OAuth client](/connect/managed-auth/oauth-clients/#using-a-custom-oauth-client).

---

683-684: Consistent doc update for OAuth credential retrieval
This second callout mirrors the one above, removing environment-specific notes and reinforcing that only custom OAuth clients can retrieve credentials. Please ensure both instances remain in sync with identical wording and link targets.

Align phrasing here as well, using the same “custom OAuth client” terminology for consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4227fec and 79c8ec0.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (1)

• docs-v2/pages/connect/api.mdx (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Lint Code Base
• GitHub Check: pnpm publish
• GitHub Check: validate-links