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

@@ -22139,17 +22139,6 @@ paths:
'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
/admin/order-edits/{id}/confirm:
post:
operationId: PostOrderEditsIdConfirm
@@ -22212,16 +22201,6 @@ paths:
'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
/admin/order-edits/{id}/items:
post:
operationId: PostOrderEditsIdItems
@@ -22604,17 +22583,6 @@ paths:
'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
/admin/order-edits/{id}/shipping-method:
post:
operationId: PostOrderEditsIdShippingMethod

View File

@@ -64,14 +64,3 @@ delete:
'500':
$ref: ../components/responses/500_error.yaml
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

@@ -45,13 +45,3 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
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

@@ -45,14 +45,3 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
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

@@ -1,2 +1,6 @@
curl -X POST '{backend_url}/store/carts' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
-H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{
"region_id": "reg_123"
}'

View File

@@ -857,7 +857,11 @@ paths:
label: cURL
source: |-
curl -X POST '{backend_url}/store/carts' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
-H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{
"region_id": "reg_123"
}'
tags:
- Carts
responses:
@@ -1079,15 +1083,6 @@ paths:
```
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

View File

@@ -175,15 +175,6 @@ post:
```
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