connect object in apps API #17094
connect object in apps API #17094
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughThe documentation for the Connect API Proxy and app metadata was expanded and restructured. New sections clarify prerequisites, request parameter usage, domain handling, and rate limits. Tabbed code examples were introduced for SDK and REST API usage. The app metadata now documents a Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant SDK/REST API
participant Connect Proxy
participant App
User->>SDK/REST API: Send request (with URL, method, body, headers)
SDK/REST API->>Connect Proxy: Forward request (with validated parameters)
Connect Proxy->>App: Proxy request (using base_proxy_target_url or relative path)
App-->>Connect Proxy: Respond with API data
Connect Proxy-->>SDK/REST API: Return proxied response
SDK/REST API-->>User: Deliver API response
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:
SupportNeed 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)
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 (1)
docs-v2/pages/connect/api-proxy.mdx (1)
234-239: Rate limits section updated.The new limit of 1,000 requests per 5 minutes per project and the 30s timeout are clearly stated. Consider changing the comma after "requests to," to a colon for grammatical consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (3)
docs-v2/pages/connect/api-proxy.mdx(6 hunks)docs-v2/pages/connect/components/index.mdx(1 hunks)docs-v2/pages/rest-api/index.mdx(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: pnpm publish
- GitHub Check: validate-links
- GitHub Check: Lint Code Base
🔇 Additional comments (18)
docs-v2/pages/connect/components/index.mdx (1)
126-131: Connect metadata snippet for GitLab is correct.The new
connectobject in the response example accurately reflectsproxy_enabled,allowed_domains, and the templatedbase_proxy_target_url. It aligns with the API Proxy docs and thecustom_fields.base_api_urlplaceholder usage.docs-v2/pages/rest-api/index.mdx (2)
394-399: Addedconnectobject to List Apps response.The snippet for Slack and Slack Bot correctly shows
proxy_enabled,allowed_domains, andbase_proxy_target_urlunder the newconnectfield. It matches the updates in the Connect docs.
467-475: Updated single-app response withconnectmetadata.The example under "Get an App" mirrors the List Apps response format, including the new
connectobject with the expected properties. It’s consistent and accurate.docs-v2/pages/connect/api-proxy.mdx (15)
1-1: Import ofTabscomponent is necessary and correct.The addition of
import { Tabs } from 'nextra/components'enables usage of tabbed examples throughout this doc.
28-30: New "Prerequisites" section improves clarity.Listing OAuth client, environment, external user ID, and account ID up front helps readers prepare before using the proxy.
46-49: "Sending requests" section restructured for readability.Breaking out URL, method, body, and headers as separate bullets makes the requirements clear.
56-56: Dynamic domains callout enhances guidance.The note on using relative paths for dynamic domains is precise and references the later detailed section.
72-75: Tabbed examples header added.Introducing the
<Tabs>block under "Examples" properly organizes Node.js vs cURL snippets.
114-115: Second tab initiation is correct.The switch from JS to cURL within the
<Tabs.Tab>is implemented properly.
139-140: Closing tab components are in place.The closing
</Tabs.Tab>and</Tabs>tags correctly terminate the example block.
142-143: "Allowed domains" section introduction is clear.Adding a dedicated heading makes domain restrictions discoverable.
146-147: "Understanding the Connect object" header added.This title clearly segues into the JSON schema explanation.
151-161: Connect object JSON example is accurate.The sample response correctly shows
proxy_enabled,allowed_domains, and templatedbase_proxy_target_url.
165-169: Property description table is well-formatted.The markdown table accurately defines each field in the
connectobject.
174-179: Static vs relative URL guidance is precise.Explaining that both full URLs and relative paths work for static domains helps prevent confusion.
180-185: Dynamic domain usage guidelines are correct.Mandating relative paths when placeholders are present aligns with the proxy’s behavior.
190-192: Slack vs GitLab example tabs are set up properly.Demonstrating static and dynamic URL usage side-by-side aids comprehension.
213-232: Programmatic discovery snippet is helpful.Showing both SDK and REST API methods to filter for proxy-enabled apps makes integration easier.
out of /workflows, into /components
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
docs-v2/pages/connect/api-proxy.mdx (3)
28-28: Refine introductory sentence for clarity
Consider rephrasing to “You can send requests to the Connect proxy using either the Pipedream SDK with a fetch-style interface or the Pipedream REST API” for parallel structure.
30-30: Use a heading for “Prerequisites”
For consistent styling, convert the bold label to a markdown heading (e.g.### Prerequisites) rather than inline bold text.
46-46: Minor wording tweak for parameters introduction
To align with other sections, you might say “When making requests to the Connect Proxy, you must provide the following parameters:”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (16)
docs-v2/next.config.mjs(1 hunks)docs-v2/pages/components/contributing/_meta.tsx(1 hunks)docs-v2/pages/components/contributing/actions-quickstart.mdx(1 hunks)docs-v2/pages/components/contributing/api.mdx(3 hunks)docs-v2/pages/components/contributing/cli/install.mdx(1 hunks)docs-v2/pages/components/contributing/cli/login.mdx(4 hunks)docs-v2/pages/components/contributing/cli/reference.mdx(4 hunks)docs-v2/pages/components/contributing/sources-quickstart.mdx(2 hunks)docs-v2/pages/components/contributing/typescript.mdx(1 hunks)docs-v2/pages/components/index.mdx(3 hunks)docs-v2/pages/connect/api-proxy.mdx(6 hunks)docs-v2/pages/hidden/scheduling-future-tasks/index.mdx(1 hunks)docs-v2/pages/rest-api/auth.mdx(1 hunks)docs-v2/pages/rest-api/webhooks.mdx(1 hunks)docs-v2/pages/workflows/_meta.tsx(0 hunks)docs-v2/pages/workflows/building-workflows/sources.mdx(2 hunks)
💤 Files with no reviewable changes (1)
- docs-v2/pages/workflows/_meta.tsx
✅ Files skipped from review due to trivial changes (12)
- docs-v2/pages/components/contributing/cli/install.mdx
- docs-v2/pages/components/contributing/actions-quickstart.mdx
- docs-v2/pages/hidden/scheduling-future-tasks/index.mdx
- docs-v2/pages/components/contributing/typescript.mdx
- docs-v2/pages/rest-api/webhooks.mdx
- docs-v2/pages/components/contributing/cli/login.mdx
- docs-v2/pages/components/contributing/_meta.tsx
- docs-v2/pages/rest-api/auth.mdx
- docs-v2/pages/components/contributing/cli/reference.mdx
- docs-v2/pages/workflows/building-workflows/sources.mdx
- docs-v2/pages/components/index.mdx
- docs-v2/pages/components/contributing/api.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Lint Code Base
- GitHub Check: pnpm publish
- GitHub Check: validate-links
🔇 Additional comments (10)
docs-v2/pages/components/contributing/sources-quickstart.mdx (1)
39-48: CLI link updates look correctAll updated paths (
/components/contributing/cli/install/,login/, andreference/) reflect the new docs hierarchy and include the trailing slash required by thetrailingSlash: truesetting.Also applies to: 70-70
docs-v2/pages/connect/api-proxy.mdx (9)
1-1: Verify correct import ofTabscomponent
Ensure thatTabsis correctly imported fromnextra/componentsand that this path aligns with the version of Nextra used in docs-v2.
48-49: Request parameters section is well-structured
The H4 header and spacing make it easy to scan.
56-56: Info callout for dynamic domains is appropriate
This clear guidance on using relative paths for dynamic domains will help users avoid errors.
72-74: ReviewTabscomponent usage for examples
Confirm that the<Tabs items={['Node.js','cURL']}>and<Tabs.Tab>children align correctly with the Nextra API and render the intended tabs.
114-115: Ensure consistency in the second code tab
The<Tabs.Tab>wrapper and the Bash code fence should mirror the structure of the Node.js example. Double-check that the tab label matches the second entry initems.
142-146: Approve new “Allowed domains” and “Connect object” sections
These headings and accompanying text integrate smoothly into the flow and clearly explain how to inspect app proxy support.
170-180: Approve “When to use relative vs full URLs” guidance
Heading levels, slug (“when-to-use-relative-vs-full-urls”), and examples for static vs dynamic domains are clear and accurate.
236-237: Approve updated rate limit bullets
The new limits (1,000 reqs/5 min, 30 s timeout) match the latest API behavior, and status codes are properly backticked.
139-140:⚠️ Potential issueRemove duplicate closing
</Tabs>tag
There are two</Tabs>closures; only one is required to close the component.Proposed diff:
- </Tabs> - </Tabs> + </Tabs>Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs-v2/pages/connect/components/custom-tools.mdx (1)
15-15: Use Title Case for section headings
The level-2 headings "## Creating custom tools" and "## Using custom tools" currently use sentence case. For consistency with other titles (e.g., "## Overview", "## Publishing for Connect"), convert these to Title Case:
- "## Creating Custom Tools"
- "## Using Custom Tools"
Also applies to: 46-46
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs-v2/next.config.mjs(1 hunks)docs-v2/pages/connect/components/_meta.tsx(1 hunks)docs-v2/pages/connect/components/custom-tools.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs-v2/pages/connect/components/_meta.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs-v2/next.config.mjs
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/components/custom-tools.mdx
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...accepts two values: - development: makes the component available to your P...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
- GitHub Check: pnpm publish
🔇 Additional comments (1)
docs-v2/pages/connect/components/custom-tools.mdx (1)
1-96: Well-written and comprehensive documentation
This new "Using Custom Tools" page is clear, follows established patterns, and aligns with the rest of the Connect docs.🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...accepts two values: -development: makes the component available to your P...(UNLIKELY_OPENING_PUNCTUATION)
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
docs-v2/pages/connect/api-proxy.mdx (1)
151-163: Invalid JSON comments in snippet
Standard JSON doesn’t support//comments. Either remove the inline comment or switch the code fence tojsonc.Suggested fix:
- ```json + ```jsoncOr remove the
// ...other fields...line entirely.
🧹 Nitpick comments (7)
docs-v2/pages/connect/components/custom-tools.mdx (5)
5-6: Split long intro sentence
Consider breaking the first sentence into two for improved readability.Example:
-In addition to the public triggers and actions in Pipedream's global registry, you can write and publish your own components to your workspace to use with Connect. +You can write and publish your own components to your workspace to use with Connect. This complements the public triggers and actions available in Pipedream's global registry.
29-33: Link CLI reference
Hyperlink thepd publishcommand to the CLI docs for quick access.Example:
-To make your custom components available in Connect, use the `pd publish` command with the `--connect-environment` flag: +To make your custom components available in Connect, use the [`pd publish`](/components/contributing/cli/reference/#pd-publish) command with the `--connect-environment` flag:
60-69: Specify code block language
Add a language hint (bashorhttp) to the code fence for syntax highlighting.Example:
-``` +```bash
90-97: Link to versioning guide
Provide a direct link for the "Version management" best practice to guide users to detailed versioning instructions.Example:
-**Version management**: Update component versions when making changes +**Version management**: Update component versions when making changes. See [component versioning guide](/components/contributing/versioning/) for details.
98-100: Clarify Connect docs link
The[Connect docs](/connect/)link is generic; point users directly to the Connect API documentation for targeted guidance.Example:
-For Connect-specific integration help, refer to the [Connect docs](/connect/). +For Connect-specific integration help, refer to the [Connect API docs](/connect/api/).docs-v2/pages/connect/api-proxy.mdx (2)
47-48: Inconsistent capitalization of “proxy”
The heading uses “Connect Proxy” but elsewhere it’s “Connect proxy.” Consider standardizing to one style (e.g., lowercase “proxy”).
75-114: Node.js example placeholders could be clarified
The placeholder syntax{development | production}isn’t valid JavaScript and may confuse readers. Consider using angle brackets or quoted strings to denote placeholders.Example diff:
- environment: {development | production}, + environment: "<development | production>",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs-v2/pages/connect/api-proxy.mdx(6 hunks)docs-v2/pages/connect/components/custom-tools.mdx(1 hunks)docs-v2/pages/connect/mcp/developers.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs-v2/pages/connect/mcp/developers.mdx
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/components/custom-tools.mdx
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...accepts two values: - development: makes the component available to your P...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
- GitHub Check: pnpm publish
🔇 Additional comments (15)
docs-v2/pages/connect/components/custom-tools.mdx (2)
1-1: Verify component import path
Confirm that the<Callout>component import path (@/components/Callout) matches the directory structure and alias configuration in your Docusaurus setup.
37-39: Skip loose punctuation warning
The colon after "accepts two values:" is intentional and grammatically correct in this context.🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...accepts two values: -development: makes the component available to your P...(UNLIKELY_OPENING_PUNCTUATION)
docs-v2/pages/connect/api-proxy.mdx (13)
1-1: AddedTabsimport for code examples
ImportingTabsfromnextra/componentsaligns with the new tabbed examples below.
6-6: Clear description of the Connect proxy API
The new opening sentence concisely explains the proxy’s purpose.
30-30: Introduced Prerequisites section
Good addition—clearly outlines requirements before making requests.
57-57: Good clarification for dynamic domains
The callout succinctly highlights when to use relative paths for apps with dynamic domains.
73-74: Added “Examples” subsection
The new examples header improves discoverability of SDK and cURL snippets.
115-141: cURL example looks good
The REST API snippet clearly demonstrates obtaining a token and making the proxy request.
143-144: New “Allowed domains” section
This section effectively informs users how to discover domain support.
147-150: Understanding the Connect object section
The new header and description give clear context for theconnectmetadata object.
171-174: Clear guidance on URL usage
The explanation ofbase_proxy_target_urldrives home when to use full vs. relative URLs.
181-187: Dynamic domains section is clear
The note on requiring relative paths for dynamic domains aligns with the callout above.
191-203: Slack static domain example approved
The snippet demonstrates both full-URL and relative-path usage clearly.
204-212: GitLab dynamic domain example approved
Shows relative-path requirement for self-hosted instances succinctly.
235-238: Updated rate limit and timeout details
The new limits section accurately reflects the 1,000 requests per 5 minutes cap and 30-second timeout.
WHY
Summary by CodeRabbit