Docs for dynamic url support in Connect proxy #16168
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis pull request updates the documentation for the Connect API Proxy in the docs-v2 repository. The changes include modifications to the authentication section header and a rephrasing of the OAuth authentication explanation. Expanded guidance now details how to structure requests—including URL, HTTP method, body, and headers—while removing outdated examples. Additionally, instructions for REST API usage have been simplified, the "Rate limits" section has been reformatted as "Limits," and a project identifier variable has been renamed. Changes
Poem
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. 🪧 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 (2)
docs-v2/pages/connect/api-proxy.mdx (2)
42-47: Refine URL Section and Address Grammatical Detail
The updated URL subsection provides clear instructions on using the API endpoint and the requirement for a URL-safe Base64 encoded string. Note that line 47 currently states "an URL-safe Base64 encoded string"—it would be grammatically correct to use "a URL-safe Base64 encoded string."🧰 Tools
🪛 LanguageTool
[misspelling] ~47-~47: 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)
138-143: Revise Limits Section Call-to-Action
The reformatted Limits section is clearer regarding rate limits and timeouts. Consider adding "please" to the call-to-action on line 142 for a more courteous invitation (e.g., "… if you please let us know if you need higher limits").🧰 Tools
🪛 LanguageTool
[style] ~143-~143: This expression usually appears with a “please” in front of it.
Context: ... return a504error to the caller. - 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(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/api-proxy.mdx
[misspelling] ~47-~47: 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)
[style] ~143-~143: This expression usually appears with a “please” in front of it.
Context: ... return a 504 error to the caller. - 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 (4)
docs-v2/pages/connect/api-proxy.mdx (4)
36-40: Inclusive Header and Enhanced Credential Explanation
The updated header now reads "Authenticating on behalf of your users," which is more inclusive. The accompanying description clearly explains the benefit of letting Pipedream automatically insert credentials. Overall, these changes improve clarity for users.
49-52: Effective Explanation for Dynamic Base Domains
The new callout clarifies how dynamic base domains (e.g., for Zendesk or Zoho) are handled and why passing a relative path is necessary. This addition is well-structured and adds useful context for users.
54-65: Well-Organized Request Component Details
The breakdown into separate subsections for "HTTP method," "Body," and "Headers" makes the section clear and easy to follow. The instructions are concise and align with the intended usage of the proxy.
76-76: Updated Project ID Placeholder
Renaming the variable toyour_pipedream_project_i_denhances clarity and explicitness compared to the previous placeholder. Please ensure that this change is reflected consistently across all related documentation and configuration references.
WHY
Summary by CodeRabbit