Fix typo in SDK docs for getAccountById

[jverce]

Changelog

• Remove the unsupported opts from the Connect docs
• Add JSDoc example in the SDK with the actually supported params
• Bump patch version of the SDK

Summary by CodeRabbit

• Documentation

  • Updated documentation for the getAccountById method in the SDK
  • Added a newline character in the Connect API documentation

• Version Update

  • Bumped SDK package version from 1.1.5 to 1.1.6

• Improvements

  • Enhanced getAccountById method with optional params argument to provide more flexibility when retrieving account information

[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	Jan 21, 2025 10:41pm

1 Skipped Deployment

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

[vercel]

@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

This pull request involves minor updates to the Pipedream SDK documentation and package version. The changes include updating the getAccountById method in the backend client to support an optional params argument, revising its documentation, and incrementing the package version from 1.1.5 to 1.1.6. A newline character was also added to the Connect API documentation file.

Changes

File	Change Summary
docs-v2/pages/connect/api.mdx	Added a newline character at the end of the file
packages/sdk/CHANGELOG.md	Added changelog entry for version 1.1.6
packages/sdk/package.json	Updated package version from 1.1.5 to 1.1.6
packages/sdk/src/server/index.ts	Modified getAccountById method to accept optional params argument and updated method documentation

Sequence Diagram

sequenceDiagram
    participant Client
    participant BackendClient
    participant AccountService
    
    Client->>BackendClient: getAccountById(accountId, params)
    Note over BackendClient: params = { include_credentials: true }
    BackendClient->>AccountService: Retrieve Account
    AccountService-->>BackendClient: Return Account Details
    BackendClient-->>Client: Return Account

Loading

Possibly related PRs

• Danny/connect api docs patch2 #14929: Documentation changes for Pipedream Connect API
• Rev to component docs for Connect #14983: Enhancing Connect API documentation clarity
• Docs - fix typo #15040: Fixing documentation typos for Connect components

Suggested labels

enhancement, documentation, sdk

Suggested reviewers

• dylburger
• tjk

Poem

🐰 A rabbit's ode to SDK delight,
Docs polished, version set just right,
getAccountById now more clear,
With params dancing without fear,
Code evolves with gentle might! 🚀

---

📜 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 8c278bf and aad1521.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (4)

• docs-v2/pages/connect/api.mdx (1 hunks)
• packages/sdk/CHANGELOG.md (1 hunks)
• packages/sdk/package.json (1 hunks)
• packages/sdk/src/server/index.ts (1 hunks)

✅ Files skipped from review due to trivial changes (3)

• packages/sdk/CHANGELOG.md
• packages/sdk/package.json
• docs-v2/pages/connect/api.mdx

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: pnpm publish

🔇 Additional comments (2)

packages/sdk/src/server/index.ts (2)

265-280: Documentation looks good!

The added documentation clearly explains the new params parameter and provides a helpful example demonstrating the usage of include_credentials.

---

Line range hint 283-289: Implementation looks good!

The method signature has been updated correctly with an optional params parameter that defaults to an empty object, and the implementation properly passes these params to the request.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.