docs: support version in events reference (#12422)

* docs: support version in events reference

* remove changes in events output

* remove events emitted in comments

* remove customer updated event

* check for emitEventStep usage

* fixes
This commit is contained in:
Shahed Nasser
2025-05-09 14:34:15 +03:00
committed by GitHub
parent 091041f2da
commit e09b2a4db5
24 changed files with 91 additions and 636 deletions

View File

@@ -24,17 +24,6 @@
],
"deprecated": false
},
{
"name": "cart.customer_updated",
"parentName": "CartWorkflowEvents",
"propertyName": "CUSTOMER_UPDATED",
"payload": "```ts\n{\n id, // The ID of the cart\n}\n```",
"description": "Emitted when the customer in the cart is updated.",
"workflows": [
"updateCartWorkflow"
],
"deprecated": false
},
{
"name": "cart.region_updated",
"parentName": "CartWorkflowEvents",
@@ -233,7 +222,7 @@
"name": "order-edit.confirmed",
"parentName": "OrderEditWorkflowEvents",
"propertyName": "CONFIRMED",
"payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n}\n```",
"payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n```",
"description": "Emitted when an order edit request is confirmed.",
"workflows": [
"confirmOrderEditRequestWorkflow"

View File

@@ -79,17 +79,6 @@
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: cancelBeginOrderEditWorkflow
* x-events:
* - name: order-edit.canceled
* payload: |-
* ```ts
* {
* order_id, // The ID of the order
* actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
* }
* ```
* description: Emitted when an order edit request is canceled.
* deprecated: false
*
*/

View File

@@ -60,16 +60,6 @@
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: confirmOrderEditRequestWorkflow
* x-events:
* - name: order-edit.confirmed
* payload: |-
* ```ts
* {
* order_id, // The ID of the order
* actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
* ```
* description: Emitted when an order edit request is confirmed.
* deprecated: false
*
*/

View File

@@ -60,17 +60,6 @@
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: requestOrderEditRequestWorkflow
* x-events:
* - name: order-edit.requested
* payload: |-
* ```ts
* {
* order_id, // The ID of the order
* actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
* }
* ```
* description: Emitted when an order edit is requested.
* deprecated: false
*
*/

View File

@@ -113,15 +113,6 @@
* ```
* description: Emitted when a cart's details are updated.
* deprecated: false
* - name: cart.customer_updated
* payload: |-
* ```ts
* {
* id, // The ID of the cart
* }
* ```
* description: Emitted when the customer in the cart is updated.
* deprecated: false
* - name: cart.region_updated
* payload: |-
* ```ts