update connect API docs #13145
update connect API docs #13145
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
WalkthroughThe recent changes enhance both capacity and documentation for Pipedream Connect. The Changes
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 as PR comments)
Additionally, you can add 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
Outside diff range, codebase verification and nitpick comments (3)
docs-v2/pages/connect/index.mdx (3)
Line range hint
107-121:
Example response for "List all accounts" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",
412-412: Possible missing article.Consider adding an article for clarity: "Delete an individual connected account."
- Delete individual connected account + Delete an individual connected accountTools
LanguageTool
[uncategorized] ~412-~412: Possible missing article found.
Context: ...6T22:50:01.000Z" } ] ``` #### Delete individual connected account Delete a specific con...(AI_HYDRA_LEO_MISSING_AN)
428-428: Incomplete sentence.Consider revising to form a complete sentence: "Delete all connected accounts for a specific app."
- /DELETE /apps/:app_id/accounts + DELETE all connected accounts for a specific appTools
LanguageTool
[style] ~428-~428: To form a complete sentence, be sure to include a subject.
Context: .../apps/:app_id/accounts ``` -:app_idcan be `oauth_app_id` or `app_id` - We'll r...(MISSING_IT_THERE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs-v2/next.config.js (1 hunks)
- docs-v2/pages/connect/index.mdx (13 hunks)
Additional context used
LanguageTool
docs-v2/pages/connect/index.mdx
[uncategorized] ~412-~412: Possible missing article found.
Context: ...6T22:50:01.000Z" } ] ``` #### Delete individual connected account Delete a specific con...(AI_HYDRA_LEO_MISSING_AN)
[style] ~428-~428: To form a complete sentence, be sure to include a subject.
Context: .../apps/:app_id/accounts ``` -:app_idcan be `oauth_app_id` or `app_id` - We'll r...(MISSING_IT_THERE)
Gitleaks
docs-v2/pages/connect/index.mdx
369-369: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
372-372: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
Additional comments not posted (22)
docs-v2/next.config.js (1)
51-52: Increase inPUBLIC_APPSlimit.The
PUBLIC_APPSlimit has been increased from "2,000" to "2,200". This change allows for greater scalability by permitting more public applications.docs-v2/pages/connect/index.mdx (21)
6-14: Addition of the "Overview" section.The new "Overview" section provides a clear and concise description of Pipedream Connect and its features. This improves the documentation's clarity and usability.
17-21: Informative callout for feedback.The callout informs users that Pipedream Connect is in preview and requests feedback. This is a good practice to gather user input and improve the service.
29-32: Clarification on enabling the feature flag.The instructions for enabling the feature flag and contacting support are clear and helpful for users.
36-40: Domain verification and OAuth client configuration.The steps for domain verification and OAuth client configuration are well-documented, making it easier for users to follow.
43-44: Project setup instructions.The instructions for setting up a Pipedream project and noting the keys are clear and necessary for proper configuration.
47-49: Example app and SDK installation.The steps for installing the SDK and running the example app are straightforward, providing a good starting point for users.
52-52: Retrieving user credentials.The reference to the API documentation for retrieving user credentials is helpful for users to understand how to use the API.
60-62: Warning about different Base URL and authentication method.The warning about the different Base URL and authentication method for the Connect REST API is crucial for users to avoid confusion.
64-67: Base URL for Connect requests.The base URL for Connect requests is clearly specified, which is essential for making API calls.
69-69: Authentication method for Connect REST API.The explanation of the authentication method using Basic Auth is clear and includes an example, which is very helpful for users.
87-92: List all accounts endpoint.The description and example response for the "List all accounts" endpoint are clear. The warning about pagination is important for users to understand the current limitations.
Line range hint
134-147:
Example response for "List all accounts" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",
160-160: Example response for "List all accounts" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",
190-190: Example response for "List all connected accounts for an app" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",
209-211: Retrieve account details for a specific auth provision.The description and example response for this endpoint are clear and helpful for users.
226-226: Example response for "Retrieve account details for a specific auth provision" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",
252-252: Example response with credentials for "Retrieve account details for a specific auth provision" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",
277-280: Retrieve account details for a specific external user.The description and example response for this endpoint are clear and helpful for users.
291-314: Example response for "Retrieve account details for a specific external user" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",
348-373: Example response with credentials for "Retrieve account details for a specific external user" endpoint.The example response is detailed and provides a good reference for users. However, there is a redundant
external_idfield that should be removed.- "external_id": "user-abc-123",Tools
Gitleaks
369-369: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
372-372: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
401-401: Detected generic API key.The API key should not be exposed in the documentation. Consider using a placeholder or removing it.
- "oauth_access_token": "gho_zasPWxxxxxxxxxxxxx",
| "oauth_client_id": "dd7a26ca-ba11-4f80-8667-508364f97c58", | ||
| "oauth_access_token": "oaarBssnxxxxxxxxxx.v1.xxxxxxxxxx.xxxxxxxxxx", | ||
| "oauth_refresh_token": "oaarBssnxxxxxxxxxx.v1.refresh.xxxxxxxxxx.xxxxxxxxxx", | ||
| "oauth_uid": "usrnbIhrdiaOwPf7q" |
There was a problem hiding this comment.
Detected generic API key.
The API key should not be exposed in the documentation. Consider using a placeholder or removing it.
- "oauth_access_token": "oaaLa2Ob1umiregWa.v1.xxxxxxxx.xxxxxxxx",
- "oauth_refresh_token": "oaaLa2Ob1umiregWa.v1.refresh.xxxxxxxx",Committable suggestion was skipped due to low confidence.
Tools
Gitleaks
369-369: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
372-372: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
WHY
Summary by CodeRabbit
New Features
Documentation