diff --git a/packages/core/core-flows/src/common/steps/create-remote-links.ts b/packages/core/core-flows/src/common/steps/create-remote-links.ts index bec329186c..a1627cca1f 100644 --- a/packages/core/core-flows/src/common/steps/create-remote-links.ts +++ b/packages/core/core-flows/src/common/steps/create-remote-links.ts @@ -5,17 +5,17 @@ import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk" export const createLinksStepId = "create-remote-links" /** - * This step creates remote links between two records of linked data models. + * This step creates links between two records of linked data models. * - * Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link). + * Learn more in the [Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/link#create-link). * * @example * createRemoteLinkStep([{ * [Modules.PRODUCT]: { * product_id: "prod_123", * }, - * "helloModuleService": { - * my_custom_id: "mc_123", + * blog: { + * post_id: "post_123", * }, * }]) */ diff --git a/packages/core/core-flows/src/common/steps/dismiss-remote-links.ts b/packages/core/core-flows/src/common/steps/dismiss-remote-links.ts index ab5c17793b..85e92efc2a 100644 --- a/packages/core/core-flows/src/common/steps/dismiss-remote-links.ts +++ b/packages/core/core-flows/src/common/steps/dismiss-remote-links.ts @@ -9,17 +9,17 @@ export type DismissRemoteLinksStepInput = LinkDefinition | LinkDefinition[] // TODO: add ability for this step to restore links from only foreign keys export const dismissRemoteLinkStepId = "dismiss-remote-links" /** - * This step removes remote links between two records of linked data models. + * This step removes links between two records of linked data models. * - * Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#dismiss-link). + * Learn more in the [Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/link#dismiss-link). * * @example * dismissRemoteLinkStep([{ * [Modules.PRODUCT]: { * product_id: "prod_123", * }, - * "helloModuleService": { - * my_custom_id: "mc_123", + * blog: { + * post_id: "post_123", * }, * }]) */ diff --git a/packages/core/core-flows/src/common/steps/remove-remote-links.ts b/packages/core/core-flows/src/common/steps/remove-remote-links.ts index b191f79b2e..9607314776 100644 --- a/packages/core/core-flows/src/common/steps/remove-remote-links.ts +++ b/packages/core/core-flows/src/common/steps/remove-remote-links.ts @@ -7,9 +7,9 @@ type RemoveRemoteLinksStepInput = DeleteEntityInput | DeleteEntityInput[] export const removeRemoteLinkStepId = "remove-remote-links" /** - * This step deletes linked records of a record. + * This step deletes linked records of a record if cascade deletion is enabled. * - * Learn more in the [Remote Link documentation](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#cascade-delete-linked-records) + * Learn more in the [Link documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link#cascade-delete-linked-records) * * @example * removeRemoteLinkStep([{ diff --git a/packages/core/core-flows/src/common/steps/update-remote-links.ts b/packages/core/core-flows/src/common/steps/update-remote-links.ts index d9f06e2e8c..7558653f61 100644 --- a/packages/core/core-flows/src/common/steps/update-remote-links.ts +++ b/packages/core/core-flows/src/common/steps/update-remote-links.ts @@ -8,9 +8,10 @@ import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk" export const updateRemoteLinksStepId = "update-remote-links-step" /** - * This step updates remote links between two records of linked data models. + * This step updates links between two records of linked data models. This is useful to update + * links with additional data such as metadata. * - * Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link). + * Learn more in the [Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/link#update-links). * * @example * const data = updateRemoteLinksStep([ @@ -18,8 +19,8 @@ export const updateRemoteLinksStepId = "update-remote-links-step" * [Modules.PRODUCT]: { * product_id: "prod_321", * }, - * "helloModuleService": { - * my_custom_id: "mc_321", + * blog: { + * post_id: "post_321", * }, * data: { * metadata: {