Danny/connect deployed triggers docs patch

[dannyroosevelt]

WHY

Summary by CodeRabbit

• Documentation
  • Updated API documentation to reflect a new optional path parameter for filtering deployed triggers by emitter type.
  • Clarified valid emitter types and added explanatory text with reference links.
  • Simplified example code in documentation by removing unnecessary extraction of endpoint URLs in schedule-based trigger deployment examples.

[vercel]

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

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		Apr 22, 2025 6:07pm
pipedream-docs	⬜️ Ignored (Inspect)			Apr 22, 2025 6:07pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Apr 22, 2025 6:07pm

[coderabbitai]

Walkthrough

The changes update API documentation and example code snippets related to deployed triggers. The API documentation now specifies a new optional path parameter, emitter_type, for the endpoint that lists deployed triggers, allowing filtering by trigger type. Explanatory text and references about emitter types are also added. Additionally, example code for deploying schedule-based triggers is simplified by removing the extraction and use of the endpoint_url property from the response object.

Changes

File(s)	Change Summary
docs-v2/pages/connect/api.mdx	Updated API documentation for listing deployed triggers: changed endpoint path, added emitter_type parameter, clarified emitter types, and added explanatory references.
docs-v2/pages/connect/components.mdx	Simplified example code by removing extraction and use of endpoint_url from the deployed trigger response.

Sequence Diagram(s)

sequenceDiagram
    User -> API: GET /deployed-triggers/{emitter_type}?external_user_id=...
    API -> Database: Query deployed triggers (filtered by emitter_type if provided)
    Database --> API: Return list of deployed triggers
    API --> User: Return filtered deployed triggers

Loading

Possibly related PRs

• Native triggers docs #16310: Updates Connect API documentation for deployed triggers, renaming identifiers and expanding deployment examples, closely related to documentation improvements in this PR.

Poem

In docs where triggers hop and play,
A new path guides the API’s way.
Emitter types now filter true,
While endpoint URLs bid adieu.
With clearer docs, we leap ahead—
A rabbit’s joy, well-documented!
🐇✨

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs-v2/pages/connect/api.mdx (1)

2250-2264: Clarify optional emitter_type path parameter usage
The {emitter_type} segment is presented as optional, but only one URL form (/deployed-triggers/{emitter_type}) is shown. Consider explicitly documenting both forms—GET /deployed-triggers (defaulting to source) and GET /deployed-triggers/{emitter_type}—or call out that omitting the segment defaults to the source type. This will remove ambiguity around how to filter by emitter type.

docs-v2/pages/connect/components.mdx (1)

925-927: Add context for omitted endpoint_url in schedule triggers
You’ve correctly removed the endpoint_url alias for schedule-based triggers since the API response doesn't include that field. To preempt confusion, consider adding a brief note (or callout) explaining that native schedule triggers don’t emit an endpoint_url and therefore only the id is returned.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3c31a74 and e863989.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (2)

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

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

• GitHub Check: pnpm publish
• GitHub Check: Lint Code Base
• GitHub Check: validate-links