Docs: components/api.mdx -- flesh out missing details for dynamic props

[NReilingh]

Add additionalProps() and reloadProps to API definitions

Also fixes missing useQuery in prop definition

WHY

I was trying to use dynamic props, and I needed to open the source code for the google sheets example instead of being able to understand everything I needed to from the docs page. This makes an incremental improvement by filling in a couple gaps that were missing in the API definitions.

Summary by CodeRabbit

• New Features
  • Introduced a new method async additionalProps(previousPropDefs) for dynamic prop modifications.
  • Added useQuery and reloadProps properties for real-time querying and dynamic prop reloading.
• Documentation
  • Enhanced clarity on the run method and the importance of event emission with this.$emit().

[vercel]

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

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Nov 6, 2024 11:46pm

[vercel]

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

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The pull request introduces significant updates to the api.mdx documentation for the TypeScript component API. Key modifications include the addition of a new method signature for additionalProps, allowing dynamic prop modifications, and the introduction of two new properties, useQuery and reloadProps, to enhance real-time querying and dynamic prop reloading. Additionally, clarifications regarding the run method and event emission have been made, improving the overall guidance on the component's capabilities.

Changes

File	Change Summary
docs-v2/pages/components/api.mdx	- Added method signature: async additionalProps(previousPropDefs) - Updated props to include: useQuery: boolean, reloadProps: boolean - Clarified run method regarding event emission and dedupe strategies.

Possibly related PRs

• Updating quickstart in docs based on apps UI  #13987: The changes in quickstart.mdx documentation focus on improving clarity and usability for users integrating apps, which aligns with the enhancements made to the TypeScript component API reference in the main PR.
• Update quickstart.mdx #14375: Similar to the previous PR, this update to quickstart.mdx emphasizes clearer guidance for developers, which relates to the overall goal of enhancing documentation in the main PR.

Suggested reviewers

• lcaresia
• GTFalcao

🐇 In the garden where changes bloom,
New props and methods dispel the gloom.
With useQuery and reload in play,
Our components dance in a lively way!
So hop along, let’s celebrate,
Documentation shines, oh isn’t it great! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 867f268 and f3faeef.

📒 Files selected for processing (1)

• docs-v2/pages/components/api.mdx (5 hunks)

🔇 Additional comments (3)

docs-v2/pages/components/api.mdx (3)

74-74: LGTM: Method signature addition for additionalProps.

The addition of the additionalProps method signature in the component structure is accurate and aligns with the functionality described later in the documentation.

---

131-132: LGTM: New prop properties for dynamic behavior.

The addition of useQuery and reloadProps properties is well-documented with clear descriptions:

• useQuery: Enables real-time querying for dynamic options
• reloadProps: Controls reloading of additional props

---

382-382: LGTM: Comprehensive documentation of dynamic props functionality.

The detailed explanation of dynamic props and the additionalProps method is thorough and includes:

• Clear explanation of when the method is called
• Proper method signature with previousPropDefs parameter
• Good example showing how to modify prop definitions

---

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 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.