Updating references to accounts APIs #14987
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe pull request involves the deletion of a documentation file related to accessing account credentials via the Pipedream API, which included details on OAuth processes, API calls, and best practices for security. Additionally, enhancements were made to the Pipedream REST API documentation, clarifying authentication methods, parameters, pagination, error handling, and webhook management. A new redirect was added to the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs-v2/pages/connected-accounts/api.mdx(0 hunks)docs-v2/pages/rest-api/index.mdx(0 hunks)docs-v2/vercel.json(1 hunks)
💤 Files with no reviewable changes (2)
- docs-v2/pages/connected-accounts/api.mdx
- docs-v2/pages/rest-api/index.mdx
🔇 Additional comments (1)
docs-v2/vercel.json (1)
280-284: Consider checking for additional related paths.
Since this is part of updating references to accounts APIs, we should verify if there are other documentation paths related to connected accounts that might need similar redirects.
✅ Verification successful
No additional redirects needed for connected accounts paths
Based on the search results, the only documentation paths containing "connected-accounts" are:
/docs/connected-accounts/api(which is being redirected in this change)/docs/connected-accounts/oauth-clients(which has its own redirect)
All other references to connected accounts in the documentation use the newer /connected-accounts path format (without the /docs prefix), so no additional redirects are needed.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Find other potential paths that might need updates
# Look for files/paths containing "connected-accounts"
fd "connected-accounts"
# Look for content mentioning "connected accounts" that might need updating
rg -i "connected.?accounts?" --type=mdx
Length of output: 127
Script:
#!/bin/bash
# Search for files with connected accounts references using ripgrep
# Including common documentation file extensions
rg -i "connected.?accounts?" -g "*.md" -g "*.mdx" -g "*.json" -g "*.js" -g "*.jsx" -g "*.ts" -g "*.tsx"
# List all files in the docs directory that might be documentation
fd . "docs-v2" -e md -e mdx -e json
# Specifically check vercel.json for all redirects related to accounts
rg "/docs/connected-accounts|/docs/connect" docs-v2/vercel.json
Length of output: 65751
| }, | ||
| { | ||
| "source": "/docs/connected-accounts/api", | ||
| "destination": "/docs/connect/api#accounts" | ||
| } |
There was a problem hiding this comment.
💡 Codebase verification
Redirect path verified and remaining references found
The destination path /docs/connect/api#accounts exists in docs-v2/pages/connect/api.mdx, and the content includes a comprehensive API reference with an "Accounts" section. However, there are two remaining references to the old path that need to be updated:
- docs-v2/pages/rest-api/index.mdx
- docs-v2/pages/connected-accounts/index.mdx
🔗 Analysis chain
Verify the destination path exists.
The redirect looks good, but let's ensure the destination path /docs/connect/api#accounts exists and contains the relevant content from the deleted documentation file.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the existence of the destination path and related files
# Check if the destination file exists (without the #accounts anchor)
fd -t f "api.mdx" -p "docs-v2/pages/connect/"
# Look for any remaining references to the old path
rg -i "connected-accounts/api" --type=mdx
Length of output: 143
Script:
#!/bin/bash
# Check if the destination file exists and look for the 'accounts' section
rg -l "accounts" docs-v2/pages/connect/api.mdx
# Look for any remaining references to connected-accounts, without file type restriction
rg -i "connected-accounts/api"
# Check the content of the API documentation to verify the accounts section
cat docs-v2/pages/connect/api.mdx
Length of output: 64090
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
docs-v2/pages/rest-api/index.mdx (3)
Line range hint
13-27: Consider adding authentication comparison examples.While the authentication section clearly explains the distinction between OAuth and User API keys, it would be helpful to add code examples showing both authentication methods side by side. This would make it easier for users to understand the practical differences.
Consider adding these examples:
+ // OAuth authentication (recommended) + curl https://api.pipedream.com/v1/accounts \ + -H "Authorization: Bearer <oauth_token>" + + // User API key authentication + curl https://api.pipedream.com/v1/accounts?org_id=o_abc123 \ + -H "Authorization: Bearer <user_api_key>"🧰 Tools
🪛 LanguageTool
[uncategorized] ~230-~230: Possible missing comma found.
Context: ...al credentials (API key or OAuth access token for example). #### Endpoint ``` GET /...(AI_HYDRA_LEO_MISSING_COMMA)
230-230: Improve sentence structure and punctuation.The current sentence could be clearer and is missing a comma before the parenthetical example.
Apply this change:
- By default, this route returns metadata for a specific connected account. Set `include_credentials=true` to return credentials that you can use in any app where you need the actual credentials (API key or OAuth access token for example). + By default, this route returns metadata for a specific connected account. Set `include_credentials=true` to return credentials (such as API keys or OAuth access tokens) that you can use in your apps.🧰 Tools
🪛 LanguageTool
[uncategorized] ~230-~230: Possible missing comma found.
Context: ...al credentials (API key or OAuth access token for example). #### Endpoint ``` GET /...(AI_HYDRA_LEO_MISSING_COMMA)
Line range hint
147-156: Enhance error handling documentation.The errors section could be more helpful by including specific examples of common error scenarios and their corresponding responses.
Consider adding examples like:
+ #### Common Error Scenarios + + ```json + // 400 Bad Request - Missing required parameter + { + "error": { + "message": "org_id is required when using user API keys", + "code": "BadRequest" + } + } + + // 401 Unauthorized - Invalid credentials + { + "error": { + "message": "Invalid authentication credentials", + "code": "Unauthorized" + } + } + + // 403 Forbidden - Insufficient permissions + { + "error": { + "message": "You don't have permission to access this resource", + "code": "Forbidden" + } + } + ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~230-~230: Possible missing comma found.
Context: ...al credentials (API key or OAuth access token for example). #### Endpoint ``` GET /...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs-v2/pages/connected-accounts/index.mdx(1 hunks)docs-v2/pages/rest-api/index.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/rest-api/index.mdx
[uncategorized] ~230-~230: Possible missing comma found.
Context: ...al credentials (API key or OAuth access token for example). #### Endpoint ``` GET /...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (2)
docs-v2/pages/connected-accounts/index.mdx (2)
41-43: LGTM! Clear distinction between personal and customer accounts.
The added callout effectively clarifies the scope of this documentation section and provides appropriate cross-referencing to the Connect documentation.
41-43: Verify the Connect documentation link.
Let's ensure the referenced /connect documentation path is valid and accessible.
✅ Verification successful
The Connect documentation link is valid and correctly referenced
The link to /connect is valid as:
- The Connect documentation exists at
docs-v2/pages/connect/index.mdx - The Next.js configuration shows a
basePath: "/docs", which means the MDX file will be accessible at/docs/connect - The content of the Connect documentation matches the context, as it describes Pipedream Connect functionality for customer integrations
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the referenced Connect documentation exists and is accessible
# Check if the Connect documentation file exists
fd -t f "index.mdx" docs-v2/pages/connect/
# Check for any references to this path in vercel.json redirects
if [ -f "vercel.json" ]; then
jq '.redirects[] | select(.source == "/docs/connect" or .destination | contains("/connect"))' vercel.json
fi
Length of output: 316
Script:
#!/bin/bash
# Let's verify the content and existence of the Connect documentation
# First, check if the file exists and show its content
if [ -f "docs-v2/pages/connect/index.mdx" ]; then
echo "=== Content of Connect documentation ==="
head -n 20 docs-v2/pages/connect/index.mdx
fi
# Also check if there are any other files that might contain relevant routing information
echo -e "\n=== Checking for Next.js configuration files ==="
fd -t f "next.config" -x head -n 20 {}
Length of output: 2591
1 participant
WHY
Summary by CodeRabbit