Danny/connect proxy macro docs #15602
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis pull request updates several documentation pages related to the Pipedream Connect proxy. The authentication section now clarifies how OAuth access tokens are handled automatically and updates header examples. The API documentation revises the rate limits for specific endpoints, and the OAuth clients documentation updates the operations table with clearer descriptions and new entries for embedding tools and proxy API requests. Changes
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: 0
🧹 Nitpick comments (3)
docs-v2/pages/connect/api-proxy.mdx (3)
40-41: Add a note about macro syntax sensitivity.While the macro syntax is explained, it would be helpful to add a note about case sensitivity and the importance of exact syntax (e.g., no spaces inside
{{ }}).
91-111: Add error handling and response type information.The example would be more complete with:
- Error handling for failed requests
- TypeScript type information for the response object
Example addition:
type ProxyResponse = { status: number; statusText: string; data: any; // Replace with specific type based on API response }; try { const resp = await pd.makeProxyRequest(/* ... */); console.log(resp.data); } catch (error) { console.error('Proxy request failed:', error.message); }
138-142: Add rate limit information and error examples.The documentation for custom authorization headers is clear, but consider adding:
- Rate limit information (100 requests per minute per project, as mentioned in the AI summary)
- Examples of common error responses and their meaning
Example addition:
### Rate Limits The proxy endpoint is limited to 100 requests per minute per project. ### Error Responses - 401: Invalid or expired access token - 403: Insufficient permissions - 429: Rate limit exceeded
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs-v2/pages/connect/api-proxy.mdx(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
🔇 Additional comments (1)
docs-v2/pages/connect/api-proxy.mdx (1)
38-38: LGTM! Clear explanation of automatic OAuth token handling.The documentation clearly explains that the proxy automatically handles OAuth access tokens with Bearer authentication, which is a significant usability improvement.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs-v2/pages/connect/api-proxy.mdx (3)
36-71: LGTM! Clear and well-structured authentication documentation.The authentication section effectively explains the proxy's automatic OAuth token handling and provides clear examples for different authentication methods. The macro concept is well-documented with practical examples.
Consider adding a note about security best practices, such as:
- The importance of using HTTPS
- How the proxy handles token refresh
- Any rate limiting specific to authentication attempts
117-166: LGTM! Clear REST API documentation with practical examples.The section effectively explains header formatting requirements and includes helpful examples.
Consider adding an example response to help users understand what to expect from the API. This could include:
- Sample successful response
- Common error responses
- Response headers that might be important
🧰 Tools
🪛 LanguageTool
[misspelling] ~124-~124: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...When using the REST API, this should be an URL-safe Base64 encoded string (ex, `aH...(EN_A_VS_AN)
168-170: Add "please" for a more polite tone.The rate limits section is clear and informative. Consider making the support link more polite:
-The Connect proxy limits API requests to **100 per minute per project**. [Let us know](https://pipedream.com/support) if you need higher limits. +The Connect proxy limits API requests to **100 per minute per project**. Please [let us know](https://pipedream.com/support) if you need higher limits.🧰 Tools
🪛 LanguageTool
[style] ~170-~170: This expression usually appears with a “please” in front of it.
Context: ...sts to 100 per minute per project. Let us know if you ...(INSERT_PLEASE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs-v2/pages/connect/api-proxy.mdx(5 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/api-proxy.mdx
[style] ~170-~170: This expression usually appears with a “please” in front of it.
Context: ...sts to 100 per minute per project. Let us know if you ...
(INSERT_PLEASE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
🔇 Additional comments (1)
docs-v2/pages/connect/api-proxy.mdx (1)
72-116: LGTM! Well-documented request examples.The SDK usage examples are clear, complete, and include helpful comments explaining each parameter.
WHY
Summary by CodeRabbit
GET /accountsand/proxy.These updates improve clarity and provide better user guidance on authentication and API usage.