docs: add additional data description in generated references (medusa…

…js#10944)
Stars1233 · Jan 13, 2025 · 2a2b387 · 2a2b387
1 parent 1b86c17
commit 2a2b387
Show file tree

Hide file tree

Showing 917 changed files with 13,492 additions and 12,843 deletions.
diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs
diff --git a/...s_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.createApiKeysStep/page.mdx b/...s_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.createApiKeysStep/page.mdx
@@ -23,9 +23,9 @@ const myWorkflow = createWorkflow(
   () => {
     const data = createApiKeysStep({
       "api_keys": [{
-        "title": "taedium",
-        "type": "publishable",
-        "created_by": "user_9GIqV2ijVCcadE"
+        "title": "acervus",
+        "type": "secret",
+        "created_by": "user_VvjemccZRm1P9fT0"
       }]
     })
   }

diff --git a/...nctions/core_flows.Api_Key.Steps_Api_Key.linkSalesChannelsToApiKeyStep/page.mdx b/...nctions/core_flows.Api_Key.Steps_Api_Key.linkSalesChannelsToApiKeyStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
   "my-workflow",
   () => {
     const data = linkSalesChannelsToApiKeyStep({
-      "id": "id_gs4SG6qHNzu7i7vl"
+      "id": "id_lIAGOo3vxm"
     })
   }
 )

diff --git a/...s_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.revokeApiKeysStep/page.mdx b/...s_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.revokeApiKeysStep/page.mdx
diff --git a/...s_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.updateApiKeysStep/page.mdx b/...s_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.updateApiKeysStep/page.mdx
diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createApiKeysWorkflow`. It belon
 
 This workflow creates one or more API keys.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L15" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L15" />
 
 <CodeTabs group="workflow-exection">
     <CodeTab label="Another Workflow" value="another-workflow">
@@ -30,9 +30,9 @@ const myWorkflow = createWorkflow(
       .runAsStep({
         input: {
           "api_keys": [{
-            "title": "pecto",
-            "type": "secret",
-            "created_by": "user_ZZyesoXDHhRHvJy"
+            "title": "subvenio",
+            "type": "publishable",
+            "created_by": "user_lFoawrDa6j3BQZPV"
           }]
         }
       })
@@ -58,9 +58,9 @@ export async function POST(
     .run({
       input: {
         "api_keys": [{
-          "title": "pecto",
-          "type": "secret",
-          "created_by": "user_ZZyesoXDHhRHvJy"
+          "title": "subvenio",
+          "type": "publishable",
+          "created_by": "user_lFoawrDa6j3BQZPV"
         }]
       }
     })
@@ -87,9 +87,9 @@ export default async function handleOrderPlaced({
     .run({
       input: {
         "api_keys": [{
-          "title": "pecto",
-          "type": "secret",
-          "created_by": "user_ZZyesoXDHhRHvJy"
+          "title": "subvenio",
+          "type": "publishable",
+          "created_by": "user_lFoawrDa6j3BQZPV"
         }]
       }
     })
@@ -116,9 +116,9 @@ export default async function myCustomJob(
     .run({
       input: {
         "api_keys": [{
-          "title": "pecto",
-          "type": "secret",
-          "created_by": "user_ZZyesoXDHhRHvJy"
+          "title": "subvenio",
+          "type": "publishable",
+          "created_by": "user_lFoawrDa6j3BQZPV"
         }]
       }
     })

diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx
@@ -15,7 +15,7 @@ This documentation provides a reference to the `deleteApiKeysWorkflow`. It belon
 
 This workflow deletes one or more API keys.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L12" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L12" />
 
 <CodeTabs group="workflow-exection">
     <CodeTab label="Another Workflow" value="another-workflow">
@@ -31,7 +31,7 @@ const myWorkflow = createWorkflow(
       .runAsStep({
         input: {
           "ids": [
-            "id_JpTj1834b6"
+            "id_oAdfP14QUoqh"
           ]
         }
       })
@@ -57,7 +57,7 @@ export async function POST(
     .run({
       input: {
         "ids": [
-          "id_JpTj1834b6"
+          "id_oAdfP14QUoqh"
         ]
       }
     })
@@ -84,7 +84,7 @@ export default async function handleOrderPlaced({
     .run({
       input: {
         "ids": [
-          "id_JpTj1834b6"
+          "id_oAdfP14QUoqh"
         ]
       }
     })
@@ -111,7 +111,7 @@ export default async function myCustomJob(
     .run({
       input: {
         "ids": [
-          "id_JpTj1834b6"
+          "id_oAdfP14QUoqh"
         ]
       }
     })

diff --git a/...core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx b/...core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx
@@ -15,7 +15,7 @@ This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflo
 
 This workflow links sales channels to API keys.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L13" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L13" />
 
 <CodeTabs group="workflow-exection">
     <CodeTab label="Another Workflow" value="another-workflow">
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
     const result = linkSalesChannelsToApiKeyWorkflow
       .runAsStep({
         input: {
-          "id": "id_mVzQuMhmHQ8q1iF"
+          "id": "id_fzIS54SNGIfmYj8Ad"
         }
       })
   }
@@ -54,7 +54,7 @@ export async function POST(
   const { result } = await linkSalesChannelsToApiKeyWorkflow(req.scope)
     .run({
       input: {
-        "id": "id_mVzQuMhmHQ8q1iF"
+        "id": "id_fzIS54SNGIfmYj8Ad"
       }
     })
 
@@ -79,7 +79,7 @@ export default async function handleOrderPlaced({
   const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
     .run({
       input: {
-        "id": "id_mVzQuMhmHQ8q1iF"
+        "id": "id_fzIS54SNGIfmYj8Ad"
       }
     })
 
@@ -104,7 +104,7 @@ export default async function myCustomJob(
   const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
     .run({
       input: {
-        "id": "id_mVzQuMhmHQ8q1iF"
+        "id": "id_fzIS54SNGIfmYj8Ad"
       }
     })
 

diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx
diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx
diff --git a/...ions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx b/...ions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx
@@ -13,7 +13,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
 
 This documentation provides a reference to the `generateResetPasswordTokenWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L13" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L13" />
 
 <CodeTabs group="workflow-exection">
     <CodeTab label="Another Workflow" value="another-workflow">

diff --git a/..._Cart/functions/core_flows.Cart.Steps_Cart.addShippingMethodToCartStep/page.mdx b/..._Cart/functions/core_flows.Cart.Steps_Cart.addShippingMethodToCartStep/page.mdx
@@ -23,9 +23,9 @@ const myWorkflow = createWorkflow(
   () => {
     const data = addShippingMethodToCartStep({
       "shipping_methods": [{
-        "name": "Napoleon",
+        "name": "Emory",
         "cart_id": "{value}",
-        "amount": 8
+        "amount": 46
       }]
     })
   }

diff --git a/...t/Steps_Cart/functions/core_flows.Cart.Steps_Cart.confirmInventoryStep/page.mdx b/...t/Steps_Cart/functions/core_flows.Cart.Steps_Cart.confirmInventoryStep/page.mdx
@@ -24,9 +24,9 @@ const myWorkflow = createWorkflow(
     const data = confirmInventoryStep({
       "items": [{
         "inventory_item_id": "{value}",
-        "required_quantity": 23,
+        "required_quantity": 48,
         "allow_backorder": true,
-        "quantity": 37,
+        "quantity": 33,
         "location_ids": [
           "{value}"
         ]

diff --git a/...art/functions/core_flows.Cart.Steps_Cart.createLineItemAdjustmentsStep/page.mdx b/...art/functions/core_flows.Cart.Steps_Cart.createLineItemAdjustmentsStep/page.mdx
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
     const data = createLineItemAdjustmentsStep({
       "lineItemAdjustmentsToCreate": [{
         "code": "{value}",
-        "amount": 10,
+        "amount": 27,
         "item_id": "{value}"
       }]
     })

diff --git a/...rt/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx b/...rt/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx
@@ -22,11 +22,11 @@ const myWorkflow = createWorkflow(
   "my-workflow",
   () => {
     const data = createLineItemsStep({
-      "id": "id_iQU9pzB53YHRh",
+      "id": "id_Qz07MRX126D4QhT",
       "items": [{
-        "title": "vulgivagus",
-        "quantity": 33,
-        "unit_price": 12,
+        "title": "bardus",
+        "quantity": 11,
+        "unit_price": 8,
         "cart_id": "{value}"
       }]
     })

diff --git a/...Cart/functions/core_flows.Cart.Steps_Cart.createPaymentCollectionsStep/page.mdx b/...Cart/functions/core_flows.Cart.Steps_Cart.createPaymentCollectionsStep/page.mdx
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
     const data = createPaymentCollectionsStep([{
       "region_id": "{value}",
       "currency_code": "{value}",
-      "amount": 8
+      "amount": 44
     }])
   }
 )

diff --git a/...nctions/core_flows.Cart.Steps_Cart.createShippingMethodAdjustmentsStep/page.mdx b/...nctions/core_flows.Cart.Steps_Cart.createShippingMethodAdjustmentsStep/page.mdx
@@ -25,7 +25,7 @@ const myWorkflow = createWorkflow(
       "shippingMethodAdjustmentsToCreate": [{
         "shipping_method_id": "{value}",
         "code": "{value}",
-        "amount": 13
+        "amount": 34
       }]
     })
   }

diff --git a/...tions/core_flows.Cart.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx b/...tions/core_flows.Cart.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx
@@ -24,73 +24,73 @@ const myWorkflow = createWorkflow(
   () => {
     const data = getActionsToComputeFromPromotionsStep({
       "cart": {
-        "id": "id_zptDVH0xHA9lBDu",
+        "id": "id_QqBWCiL5Mq0aqsfLRiM",
         "currency_code": "{value}",
         "original_item_total": {
-          "numeric": 50
+          "numeric": 41
         },
         "original_item_subtotal": {
-          "numeric": 36
+          "numeric": 3
         },
         "original_item_tax_total": {
-          "numeric": 36
+          "numeric": 45
         },
         "item_total": {
-          "numeric": 43
+          "numeric": 37
         },
         "item_subtotal": {
-          "numeric": 49
+          "numeric": 41
         },
         "item_tax_total": {
-          "numeric": 38
+          "numeric": 19
         },
         "original_total": {
-          "numeric": 0
+          "numeric": 30
         },
         "original_subtotal": {
-          "numeric": 12
+          "numeric": 15
         },
         "original_tax_total": {
-          "numeric": 11
+          "numeric": 35
         },
         "total": {
-          "numeric": 47
+          "numeric": 1
         },
         "subtotal": {
-          "numeric": 28
+          "numeric": 27
         },
         "tax_total": {
-          "numeric": 15
+          "numeric": 29
         },
         "discount_total": {
-          "numeric": 26
+          "numeric": 27
         },
         "discount_tax_total": {
-          "numeric": 43
+          "numeric": 21
         },
         "gift_card_total": {
-          "numeric": 12
+          "numeric": 23
         },
         "gift_card_tax_total": {
-          "numeric": 44
+          "numeric": 25
         },
         "shipping_total": {
-          "numeric": 46
+          "numeric": 19
         },
         "shipping_subtotal": {
-          "numeric": 14
+          "numeric": 34
         },
         "shipping_tax_total": {
-          "numeric": 29
+          "numeric": 1
         },
         "original_shipping_total": {
-          "numeric": 43
+          "numeric": 41
         },
         "original_shipping_subtotal": {
-          "numeric": 26
+          "numeric": 43
         },
         "original_shipping_tax_total": {
-          "numeric": 33
+          "numeric": 21
         },
         "raw_original_item_total": {
           "value": "{value}"

diff --git a/...Steps_Cart/functions/core_flows.Cart.Steps_Cart.getLineItemActionsStep/page.mdx b/...Steps_Cart/functions/core_flows.Cart.Steps_Cart.getLineItemActionsStep/page.mdx
@@ -23,11 +23,11 @@ const myWorkflow = createWorkflow(
   "my-workflow",
   () => {
     const data = getLineItemActionsStep({
-      "id": "id_9KdI6QFsw5",
+      "id": "id_DVg8cS9mkh8GBzj",
       "items": [{
-        "title": "tactus",
-        "quantity": 49,
-        "unit_price": 8,
+        "title": "quidem",
+        "quantity": 33,
+        "unit_price": 36,
         "cart_id": "{value}"
       }]
     })