Danny/connect docs misc #16386
Danny/connect docs misc #16386
Conversation
- cron timezones - featured weights in apps API - handling test events for deployed triggers
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Caution Review failedThe pull request is closed. WalkthroughThe documentation was updated to reflect several API and example response changes. The HTTP method for reloading component props was changed from GET to POST, and the parameter for specifying a Pipedream workflow in trigger deployment was updated from Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
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:
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 (2)
docs-v2/pages/connect/components.mdx (2)
833-833: Simplify phrasing to reduce wordiness.
Consider replacing "in order to provide visibility" with "to provide visibility" for a more concise style.🧰 Tools
🪛 LanguageTool
[style] ~833-~833: Consider a shorter alternative to avoid wordiness.
Context: ...mall set of historical events on deploy in order to provide visibility into the event shape...(IN_ORDER_TO_PREMIUM)
900-900: Correct grammar: replace "below" with "the following".
In the schedule section, change "one of the below" to "one of the following" for proper usage.🧰 Tools
🪛 LanguageTool
[grammar] ~900-~900: Did you mean “belows”?
Context: ...ning schedules, you can pass one of the below: -intervalSeconds: Define the freque...(CD_OF_THE_NN)
📜 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.mdx(2 hunks)docs-v2/pages/connect/components.mdx(3 hunks)docs-v2/pages/rest-api/index.mdx(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/components.mdx
[style] ~833-~833: Consider a shorter alternative to avoid wordiness.
Context: ...mall set of historical events on deploy in order to provide visibility into the event shape...
(IN_ORDER_TO_PREMIUM)
[grammar] ~900-~900: Did you mean “belows”?
Context: ...ning schedules, you can pass one of the below: - intervalSeconds: Define the freque...
(CD_OF_THE_NN)
⏰ 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 (9)
docs-v2/pages/connect/api.mdx (2)
1604-1604: Confirm HTTP method change for dynamic props reloading.
The endpoint now correctly usesPOST /{component_type}/propsinstead ofGET. This aligns with the implementation and ensures proper use of the request body for dynamic prop configuration.
2054-2057: Rename parameter fromworkflow_urltoworkflow_id.
The deploy trigger endpoint has been updated to acceptworkflow_id(e.g.,p_1234567) instead ofworkflow_url. The description clearly reflects this change.🧰 Tools
🪛 LanguageTool
[style] ~2056-~2056: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... The Pipedream workflow ID to which you want to emit events (ex,p_1234567). <Callou...(REP_WANT_TO_VB)
docs-v2/pages/rest-api/index.mdx (4)
393-395: Addfeatured_weightfield to List Apps response example.
Thefeatured_weightproperty has been introduced in theGET /appsJSON snippet to reflect sorting metadata returned by the API. Examples and numerical values look consistent.
406-408: Addfeatured_weightto second app in List Apps.
The example for the second app now includes thefeatured_weightfield, matching the API behavior for integrated apps.
413-415: Include callout explainingfeatured_weight.
A new informational callout clarifies the purpose offeatured_weightand its impact on app sorting. This enhances the documentation context.
458-458: Addfeatured_weightto Get an App response example.
The single-app response example now includesfeatured_weight, ensuring consistency with the List Apps documentation.docs-v2/pages/connect/components.mdx (3)
125-127: Addfeatured_weightto GitLab app metadata example.
The metadata snippet for GitLab now includes"featured_weight": 5000, aligning with REST API updates and ensuring consistency across docs.
824-824: Add missing period in informational callout.
The callout sentence now ends with a period, improving grammatical correctness.
832-837: Document handling of test events for app-based sources.
The new "Handling test events" subsection provides valuable guidance on avoiding unintended historical events. This addition clarifies best practices for trigger deployment workflows.🧰 Tools
🪛 LanguageTool
[style] ~833-~833: Consider a shorter alternative to avoid wordiness.
Context: ...mall set of historical events on deploy in order to provide visibility into the event shape...(IN_ORDER_TO_PREMIUM)
WHY
Summary by CodeRabbit