Fixing component key references in Connect docs

[dannyroosevelt]

WHY

Summary by CodeRabbit

• Documentation
  • Updated code examples to simplify how resource identifiers are passed to SDK methods, using direct string arguments instead of nested objects.
  • Clarified method signatures and parameter names in usage examples for retrieving and configuring components.
  • Added an explicit API endpoint code snippet for configuring component props.
  • Fixed minor formatting issues in code examples.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 13, 2025 10:20pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs	⬜️ Ignored (Inspect)			May 13, 2025 10:20pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			May 13, 2025 10:20pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation examples for SDK methods were updated to use direct string identifiers instead of nested objects for components, actions, triggers, and related resources. The changes affect usage patterns in code snippets and example calls, aligning them with revised method signatures. No underlying logic, control flow, or exported API declarations were modified.

Changes

Files	Change Summary
docs-v2/pages/connect/api.mdx, docs-v2/pages/connect/components.mdx	Updated all code examples to pass component, action, and trigger identifiers as direct strings or { id: string } instead of nested objects (e.g., { key: "..." }, { componentId: { key: "..." } }). Added explicit API endpoint snippet and fixed minor whitespace.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SDK
    participant API

    User->>SDK: getComponent("component-key")
    SDK->>API: GET /components/component-key
    API-->>SDK: Component definition
    SDK-->>User: Component definition

    User->>SDK: configureComponent({ id: "component-key", ... })
    SDK->>API: POST /components/configure with id
    API-->>SDK: Configuration result
    SDK-->>User: Configuration result

    User->>SDK: runAction({ id: "action-key", ... })
    SDK->>API: POST /actions/run with id
    API-->>SDK: Action result
    SDK-->>User: Action result

Loading

Suggested labels

docs, javascript

Poem

A rabbit with docs on its mind,
Smoothed out the code for all to find.
No more objects, just strings to see—
Simpler calls, as clear as can be!
Now hop along, enjoy the ride,
With streamlined docs as your guide.
🐇✨

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c433a25 and 9ab3e10.

📒 Files selected for processing (2)

• docs-v2/pages/connect/api.mdx (9 hunks)
• docs-v2/pages/connect/components.mdx (3 hunks)

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.