Updated API from documentation release

commercetools · Oct 22, 2024 · 0323605 · 0323605
1 parent cac013e
commit 0323605
Show file tree

Hide file tree

Showing 52 changed files with 160 additions and 7 deletions.
diff --git a/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json b/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json
@@ -6,5 +6,6 @@
     "project": {
       "key": "{projectKey}"
     }
-  }
-}
+  },
+  "correlationId": "spa/commercetools-checkout/1729263187262/565301612087128"
+}
diff --git a/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json b/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json
@@ -6,5 +6,6 @@
     "order": {
       "id": "{orderId}"
     }
-  }
+  },
+  "correlationId": "spa/commercetools-checkout/1729263187262/565301612087128"
 }
diff --git a/api-specs/checkout/types/responses/AddDiscountCodeError.raml b/api-specs/checkout/types/responses/AddDiscountCodeError.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Error adding discount code.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `error` object.
diff --git a/api-specs/checkout/types/responses/ApplicationDeactivated.raml b/api-specs/checkout/types/responses/ApplicationDeactivated.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Application `{applicationKey}` for `{projectKey}` is disabled.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `project` and `application` objects with the related `key` property.
diff --git a/api-specs/checkout/types/responses/BadInputData.raml b/api-specs/checkout/types/responses/BadInputData.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Some fields are invalid.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `invalidFields` array of objects with the related `schema`, `path`, `value` and `message` properties.
diff --git a/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml b/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Cart `{cartId}` was emptied during checkout.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `cart` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/CartEmpty.raml b/api-specs/checkout/types/responses/CartEmpty.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Cart `{cartId}` is empty.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `cart` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/CartNotFound.raml b/api-specs/checkout/types/responses/CartNotFound.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Cart for `{projectKey}` and session `{sessionId}` not found.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `project` and `session` objects with the related `key` and `id` properties.
diff --git a/api-specs/checkout/types/responses/CartWithExistingPayment.raml b/api-specs/checkout/types/responses/CartWithExistingPayment.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Cart with existing approved payment.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `cart` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/CheckoutCancelled.raml b/api-specs/checkout/types/responses/CheckoutCancelled.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Checkout cancelled.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/CheckoutCompleted.raml b/api-specs/checkout/types/responses/CheckoutCompleted.raml
@@ -18,3 +18,6 @@ properties:
   payload:
     type: object
     description: Contains the `order` object with the `id` property.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/CheckoutLoaded.raml b/api-specs/checkout/types/responses/CheckoutLoaded.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Checkout loaded.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/CheckoutStarted.raml b/api-specs/checkout/types/responses/CheckoutStarted.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Checkout started.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/DeprecatedFields.raml b/api-specs/checkout/types/responses/DeprecatedFields.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Some fields are deprecated.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `deprecatedFields` array.
diff --git a/api-specs/checkout/types/responses/DiscountCodeNotApplicable.raml b/api-specs/checkout/types/responses/DiscountCodeNotApplicable.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Discount code not applicable.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains string values for `cartId` and the given `discountCode`.
diff --git a/api-specs/checkout/types/responses/ExpiredSession.raml b/api-specs/checkout/types/responses/ExpiredSession.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Session is expired.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml b/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: External terms and conditions pending.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/InitError.raml b/api-specs/checkout/types/responses/InitError.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Error during initialization.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/InitTimeout.raml b/api-specs/checkout/types/responses/InitTimeout.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Timeout error, no init message received.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/InvalidLocale.raml b/api-specs/checkout/types/responses/InvalidLocale.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: The provided `{locale}` is invalid.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the provided locale string, the related locale field (language or currency), and the used fallback one.
diff --git a/api-specs/checkout/types/responses/InvalidMode.raml b/api-specs/checkout/types/responses/InvalidMode.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: \`{mode}` mode requires an application with mode type `{modeTypeRequested}`. Current mode `{modeTypeReceived}`.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/Message.raml b/api-specs/checkout/types/responses/Message.raml
@@ -6,13 +6,16 @@ discriminator: code
 description:
 properties:
   code:
-    description: The Message code for the event.
+    description: Message code for the event.
     type: string
   severity:
     description: |
-      The severity level of the event. It can be `info`, `warn`, or `error`.
+      Severity level of the event. Can be `info`, `warn`, or `error`.
     type: string
   message:
     description: |
-      A human-readable description of the event.
+      Human-readable description of the event.
     type: string
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/MultipleVendorButtonContainers.raml b/api-specs/checkout/types/responses/MultipleVendorButtonContainers.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Multiple vendor button containers detected, this may cause issues.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/NoPaymentMethods.raml b/api-specs/checkout/types/responses/NoPaymentMethods.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: There are no payment methods configured.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/NoShippingMethods.raml b/api-specs/checkout/types/responses/NoShippingMethods.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: There are no shipping methods matching cart.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `cart` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/OrderCreated.raml b/api-specs/checkout/types/responses/OrderCreated.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Order `{orderId}` created.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `order` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/OrderCreationError.raml b/api-specs/checkout/types/responses/OrderCreationError.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Order creation failed with approved payment.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains `paymentReference`, `sessionId`, and the `errors` array of objects, with the related `code` and `message` properties.
diff --git a/api-specs/checkout/types/responses/PaymentCancelled.raml b/api-specs/checkout/types/responses/PaymentCancelled.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Payment cancelled.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/PaymentConnectorError.raml b/api-specs/checkout/types/responses/PaymentConnectorError.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment connector error.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `connector` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/PaymentFailed.raml b/api-specs/checkout/types/responses/PaymentFailed.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Payment failed.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/PaymentMethodLoaded.raml b/api-specs/checkout/types/responses/PaymentMethodLoaded.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment method loaded.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `method` object with the `type` and `connectorId` properties.
diff --git a/api-specs/checkout/types/responses/PaymentMethodLoading.raml b/api-specs/checkout/types/responses/PaymentMethodLoading.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment method loading.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `method` object with the `type` and `connectorId` properties.
diff --git a/api-specs/checkout/types/responses/PaymentMethodLoadingError.raml b/api-specs/checkout/types/responses/PaymentMethodLoadingError.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment method loading failed.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `method` object with the `type` and `connectorId` properties.
diff --git a/api-specs/checkout/types/responses/PaymentMethodSelected.raml b/api-specs/checkout/types/responses/PaymentMethodSelected.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment method selected.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `method` object with the `type` and `hasVendorButton` properties.
diff --git a/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmation.raml b/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmation.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment method selected.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `method` object with the `type` and `hasVendorButton` properties.
diff --git a/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmationFailed.raml b/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmationFailed.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment method selection failed.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `method` object with the `type` property.
diff --git a/api-specs/checkout/types/responses/PaymentMethodsReceived.raml b/api-specs/checkout/types/responses/PaymentMethodsReceived.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment methods received.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `paymentMethods` array of objects with the `type` and `connectorId` properties.
diff --git a/api-specs/checkout/types/responses/PaymentStarted.raml b/api-specs/checkout/types/responses/PaymentStarted.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Payment started.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `method` object with the `type` property.
diff --git a/api-specs/checkout/types/responses/PaymentValidationFailed.raml b/api-specs/checkout/types/responses/PaymentValidationFailed.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Payment validation failed.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/PaymentValidationPassed.raml b/api-specs/checkout/types/responses/PaymentValidationPassed.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Payment validation passed.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/PaymentValidationStarted.raml b/api-specs/checkout/types/responses/PaymentValidationStarted.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Payment validation started.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/PaymentVerificationStarted.raml b/api-specs/checkout/types/responses/PaymentVerificationStarted.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Payment verification started.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/PaymentVerificationTimeout.raml b/api-specs/checkout/types/responses/PaymentVerificationTimeout.raml
@@ -15,3 +15,6 @@ properties:
   message:
     type: string
     description: Payment verification timeout.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
diff --git a/api-specs/checkout/types/responses/ProjectIsDeactivated.raml b/api-specs/checkout/types/responses/ProjectIsDeactivated.raml
@@ -15,6 +15,9 @@ properties:
   message:
     type: string
     description: Project `{projectKey}` is deactivated.
+  correlationId:
+    type: string
+    description: Unique identifier of the event.
   payload:
     type: object
     description: Contains the `project` object with the `key` property.