18953 action add knowledge functionality for dixa #18967
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added `getArticle` and `getArticleTranslations` actions to retrieve articles and their translations from Dixa. - Updated version numbers for existing actions to 0.0.3. - Incremented package version to 0.2.0 and updated dependency for `@pipedream/platform` to ^3.1.0. - Updated source components' versions to 0.0.2 for consistency.
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Contributor
WalkthroughThis release adds knowledge article retrieval functionality to the Dixa component. Two new actions ( Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GetArticleAction as Get Article Action
participant DixaApp as Dixa App
participant API as Dixa API
User->>GetArticleAction: Invoke with articleId
GetArticleAction->>DixaApp: getArticle({ articleId, $ })
DixaApp->>API: GET /knowledge/articles/{articleId}
API-->>DixaApp: Article data
DixaApp-->>GetArticleAction: Response
GetArticleAction->>GetArticleAction: Export summary
GetArticleAction-->>User: Return article data
User->>GetArticleAction: Invoke GetArticleTranslations with articleId
GetArticleAction->>DixaApp: getArticleTranslations({ articleId, $ })
DixaApp->>API: GET /knowledge/articles/{articleId}/translations
API-->>DixaApp: Translations data
DixaApp-->>GetArticleAction: Response
GetArticleAction->>GetArticleAction: Export summary
GetArticleAction-->>User: Return translations data
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Pre-merge checks and finishing touches❌ Failed checks (2 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (13)
components/dixa/actions/add-message/add-message.mjs(1 hunks)components/dixa/actions/create-conversation/create-conversation.mjs(1 hunks)components/dixa/actions/get-article-translations/get-article-translations.mjs(1 hunks)components/dixa/actions/get-article/get-article.mjs(1 hunks)components/dixa/actions/set-custom-contact-attributes/set-custom-contact-attributes.mjs(1 hunks)components/dixa/actions/tag-conversation/tag-conversation.mjs(1 hunks)components/dixa/dixa.app.mjs(1 hunks)components/dixa/package.json(2 hunks)components/dixa/sources/conversation-status-changed-instant/conversation-status-changed-instant.mjs(1 hunks)components/dixa/sources/new-conversation-created-instant/new-conversation-created-instant.mjs(1 hunks)components/dixa/sources/new-customer-satisfaction-rating-instant/new-customer-satisfaction-rating-instant.mjs(1 hunks)components/dixa/sources/new-message-added-instant/new-message-added-instant.mjs(1 hunks)components/dixa/sources/new-tag-added-instant/new-tag-added-instant.mjs(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2024-12-12T19:23:09.039Z
Learnt from: jcortes
Repo: PipedreamHQ/pipedream PR: 14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
Applied to files:
components/dixa/package.json
📚 Learning: 2025-10-20T01:01:02.970Z
Learnt from: js07
Repo: PipedreamHQ/pipedream PR: 18744
File: components/slack_v2/actions/send-large-message/send-large-message.mjs:49-64
Timestamp: 2025-10-20T01:01:02.970Z
Learning: In components/slack_v2/actions/send-large-message/send-large-message.mjs, the metadata_event_payload prop is typed as string, so the code only needs to handle string-to-JSON parsing and does not need to handle object inputs.
Applied to files:
components/dixa/actions/add-message/add-message.mjs
📚 Learning: 2024-10-08T15:33:38.240Z
Learnt from: GTFalcao
Repo: PipedreamHQ/pipedream PR: 12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Applied to files:
components/dixa/actions/get-article/get-article.mjs
🧬 Code graph analysis (2)
components/dixa/actions/get-article-translations/get-article-translations.mjs (1)
components/dixa/actions/get-article/get-article.mjs (1)
response(23-26)
components/dixa/actions/get-article/get-article.mjs (2)
components/dixa/actions/add-message/add-message.mjs (1)
response(55-68)components/dixa/actions/get-article-translations/get-article-translations.mjs (1)
response(23-26)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: pnpm publish
- GitHub Check: Publish TypeScript components
- GitHub Check: Verify TypeScript components
- GitHub Check: Lint Code Base
🔇 Additional comments (13)
components/dixa/package.json (1)
3-3: LGTM! Version bumps are appropriate.The minor version bump (0.1.0 → 0.2.0) and the platform dependency update align with adding new knowledge functionality to the Dixa integration.
Also applies to: 16-16
components/dixa/sources/new-tag-added-instant/new-tag-added-instant.mjs (1)
9-9: LGTM! Routine version bump.Version metadata updated consistently with the package release.
components/dixa/actions/set-custom-contact-attributes/set-custom-contact-attributes.mjs (1)
7-7: LGTM! Routine version bump.Version metadata updated consistently with the package release.
components/dixa/actions/add-message/add-message.mjs (1)
7-7: LGTM! Routine version bump.Version metadata updated consistently with the package release.
components/dixa/sources/new-message-added-instant/new-message-added-instant.mjs (1)
9-9: LGTM! Routine version bump.Version metadata updated consistently with the package release.
components/dixa/sources/conversation-status-changed-instant/conversation-status-changed-instant.mjs (1)
9-9: LGTM! Routine version bump.Version metadata updated consistently with the package release.
components/dixa/actions/create-conversation/create-conversation.mjs (1)
7-7: LGTM! Routine version bump.Version metadata updated consistently with the package release.
components/dixa/sources/new-customer-satisfaction-rating-instant/new-customer-satisfaction-rating-instant.mjs (1)
9-9: LGTM! Routine version bump.Version metadata updated consistently with the package release.
components/dixa/actions/tag-conversation/tag-conversation.mjs (1)
7-7: LGTM! Version bump maintains consistency.The version increment aligns with the broader updates across Dixa actions in this PR.
components/dixa/sources/new-conversation-created-instant/new-conversation-created-instant.mjs (1)
9-9: LGTM! Version bump maintains consistency.The version increment aligns with the broader updates across Dixa sources in this PR.
components/dixa/actions/get-article-translations/get-article-translations.mjs (1)
22-29: LGTM! Implementation follows established patterns.The action correctly calls the app method and exports an appropriate summary message.
components/dixa/dixa.app.mjs (1)
211-226: LGTM! New methods follow established patterns.Both
getArticleandgetArticleTranslationsmethods are correctly implemented, following the existing codebase patterns and using the_makeRequesthelper appropriately. The endpoint paths match the PR objectives.components/dixa/actions/get-article/get-article.mjs (1)
1-30: LGTM! Well-structured action implementation.The action correctly implements the article retrieval functionality, following established codebase patterns. The documentation link correctly references the v1 API, and the summary message format is appropriate.
components/dixa/actions/get-article-translations/get-article-translations.mjs
Show resolved
Hide resolved
lcaresia
approved these changes
Nov 6, 2025
Comment on lines
+16
to
+20
| articleId: { | ||
| type: "string", | ||
| label: "Article ID", | ||
| description: "The ID of the article to get", | ||
| }, |
Collaborator
There was a problem hiding this comment.
Recommended to move this prop to app file and implement async props.
Collaborator
Author
There was a problem hiding this comment.
there isn't a list articles endpoint
components/dixa/actions/get-article-translations/get-article-translations.mjs
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #18953
Summary by CodeRabbit
Release Notes
New Features
Chores