docs: generate OAS with events (#12394)

* docs: generate OAS with events * small change
2025-05-07 14:57:03 +03:00
1 parent 262064fe96
commit a3bdb3e383
@@ -120,6 +120,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteLineItemsWorkflow
+ * x-events: []
 * 
 */

@@ -70,6 +70,7 @@
 *     application/json:
 *       schema:
 *         $ref: "#/components/schemas/StoreCartRemovePromotion"
+ * x-events: []
 * 
 */

@@ -117,6 +117,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteCustomerAddressesWorkflow
+ * x-events: []
 * 
 */

@@ -202,6 +202,7 @@
 *   - cookie_auth: []
 *   - jwt_token: []
 * x-workflow: getOrdersListWorkflow
+ * x-events: []
 * 
 */

@@ -80,6 +80,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: getOrderDetailWorkflow
+ * x-events: []
 * 
 */

@@ -660,7 +660,7 @@
 *       type: string
 *       title: province
 *       description: The lower-case ISO 3166-2 province code the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
- *       example: "us-ca"
+ *       example: us-ca
 *       externalDocs:
 *         url: https://en.wikipedia.org/wiki/ISO_3166-2
 *         description: Learn more about ISO 3166-2
@@ -61,7 +61,7 @@
 *       type: string
 *       title: province
 *       description: The lower-case ISO 3166-2 province code the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
- *       example: "us-ca"
+ *       example: us-ca
 *       externalDocs:
 *         url: https://en.wikipedia.org/wiki/ISO_3166-2
 *         description: Learn more about ISO 3166-2
@@ -146,6 +146,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: listShippingOptionsForCartWorkflow
+ * x-events: []
 * 
 */

@@ -85,6 +85,20 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: generateResetPasswordTokenWorkflow
+ * x-events:
+ *   - name: auth.password_reset
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         entity_id, // The identifier of the user or customer. For example, an email address.
+ *         actor_type, // The type of actor. For example, "customer", "user", or custom.
+ *         token, // The generated token.
+ *       }
+ *       ```
+ *     description: |-
+ *       Emitted when a reset password token is generated. You can listen to this event
+ *       to send a reset password email to the user or customer, for example.
+ *     deprecated: false
 * 
 */

@@ -66,7 +66,11 @@
 *     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:
@@ -89,6 +93,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createCartWorkflow
+ * x-events:
+ *   - name: cart.created
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the cart
+ *       }
+ *       ```
+ *     description: Emitted when a cart is created.
+ *     deprecated: false
 * 
 */

@@ -103,6 +103,36 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCartWorkflow
+ * x-events:
+ *   - name: cart.updated
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the cart
+ *       }
+ *       ```
+ *     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
+ *       {
+ *         id, // The ID of the cart
+ *       }
+ *       ```
+ *     description: |-
+ *       Emitted when the cart's region is updated. This
+ *       event is emitted alongside the `cart.updated` event.
+ *     deprecated: false
 * 
 */

@@ -138,6 +138,18 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: completeCartWorkflow
+ * x-events:
+ *   - name: order.placed
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the order
+ *       }
+ *       ```
+ *     description: |-
+ *       Emitted when an order is placed, or when a draft order is converted to an
+ *       order.
+ *     deprecated: false
 * 
 */

@@ -86,6 +86,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: transferCartCustomerWorkflow
+ * x-events: []
 * 
 */

@@ -98,6 +98,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: addToCartWorkflow
+ * x-events:
+ *   - name: cart.updated
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the cart
+ *       }
+ *       ```
+ *     description: Emitted when a cart's details are updated.
+ *     deprecated: false
 * 
 */

@@ -106,6 +106,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateLineItemInCartWorkflow
+ * x-events:
+ *   - name: cart.updated
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the cart
+ *       }
+ *       ```
+ *     description: Emitted when a cart's details are updated.
+ *     deprecated: false
 * 
 */

@@ -71,6 +71,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCartPromotionsWorkflow
+ * x-events: []
 * 
 */

@@ -112,6 +112,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: addShippingMethodToCartWorkflow
+ * x-events:
+ *   - name: cart.updated
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the cart
+ *       }
+ *       ```
+ *     description: Emitted when a cart's details are updated.
+ *     deprecated: false
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateTaxLinesWorkflow
+ * x-events: []
 * 
 */

@@ -108,6 +108,16 @@
 * security:
 *   - cookie_auth: []
 *   - jwt_token: []
+ * x-events:
+ *   - name: customer.created
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the customer
+ *       }]
+ *       ```
+ *     description: Emitted when a customer is created.
+ *     deprecated: false
 * 
 */

@@ -96,6 +96,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCustomersWorkflow
+ * x-events:
+ *   - name: customer.updated
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the customer
+ *       }]
+ *       ```
+ *     description: Emitted when a customer is updated.
+ *     deprecated: false
 * 
 */

@@ -77,7 +77,7 @@
 *             type: string
 *             title: province
 *             description: The address's ISO 3166-2 province code. Must be lower-case.
- *             example: "us-ca"
+ *             example: us-ca
 *             externalDocs:
 *               url: https://en.wikipedia.org/wiki/ISO_3166-2
 *               description: Learn more about ISO 3166-2
@@ -167,6 +167,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createCustomerAddressesWorkflow
+ * x-events: []
 * 
 */

@@ -83,7 +83,7 @@
 *             type: string
 *             title: province
 *             description: The address's ISO 3166-2 province code. Must be lower-case.
- *             example: "us-ca"
+ *             example: us-ca
 *             externalDocs:
 *               url: https://en.wikipedia.org/wiki/ISO_3166-2
 *               description: Learn more about ISO 3166-2
@@ -165,6 +165,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCustomerAddressesWorkflow
+ * x-events: []
 * 
 */

@@ -102,6 +102,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: acceptOrderTransferWorkflow
+ * x-events: []
 * 
 */

@@ -92,6 +92,7 @@
 * security:
 *   - cookie_auth: []
 *   - jwt_token: []
+ * x-events: []
 * 
 */

@@ -100,6 +100,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: declineOrderTransferRequestWorkflow
+ * x-events: []
 * 
 */

@@ -101,6 +101,7 @@
 * security:
 *   - cookie_auth: []
 *   - jwt_token: []
+ * x-events: []
 * 
 */

@@ -94,6 +94,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createPaymentCollectionForCartWorkflow
+ * x-events: []
 * 
 */

@@ -73,6 +73,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createPaymentSessionsWorkflow
+ * x-events: []
 * 
 */

@@ -106,6 +106,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: calculateShippingOptionsPricesWorkflow
+ * x-events: []
 * 
 */