Updated API from documentation release

commercetools · Mar 18, 2024 · 774adcf · 774adcf
1 parent 79653b4
commit 774adcf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/api-specs/api/types/cart-discount/CartDiscountValueGiftLineItem.raml b/api-specs/api/types/cart-discount/CartDiscountValueGiftLineItem.raml
@@ -8,6 +8,8 @@ properties:
     type: ProductReference
     description: |
       Reference to a Product.
+
+      A Gift Line Item can be present on a Cart even if the referenced Product is unpublished.
   variantId:
     type: number
     format: int64

diff --git a/api-specs/api/types/cart-discount/CartDiscountValueGiftLineItemDraft.raml b/api-specs/api/types/cart-discount/CartDiscountValueGiftLineItemDraft.raml
@@ -11,6 +11,8 @@ properties:
     type: ProductResourceIdentifier
     description: |
       ResourceIdentifier of a Product.
+
+      A Gift Line Item is added to a Cart even if the referenced Product is unpublished.
   variantId:
     type: number
     format: int64

diff --git a/api-specs/api/types/cart/LineItemMode.raml b/api-specs/api/types/cart/LineItemMode.raml
@@ -3,18 +3,18 @@
 displayName: LineItemMode
 type: string
 description: |
-  Indicates how a Line Item is added to a Cart.
+  Indicates how a Line Item was added to a Cart.
 enum:
   - Standard
   - GiftLineItem
 (enumDescriptions):
   Standard: |
-    The Line Item is added during [Cart creation](ctp:api:endpoint:/{projectKey}/carts:POST) or using the [Add LineItem](ctp:api:type:CartAddLineItemAction) update action.
+    The Line Item was added during [Cart creation](ctp:api:endpoint:/{projectKey}/carts:POST) or the [Add LineItem](ctp:api:type:CartAddLineItemAction) update action.
     The Line Item quantity can be changed without restriction.
   GiftLineItem: |
-    The Line Item is added automatically by a Cart Discount with [CartDiscountValueGiftLineItem](ctp:api:type:CartDiscountValueGiftLineItem).
+    One Line Item was added automatically to a Cart by a Cart Discount with [CartDiscountValueGiftLineItemDraft](ctp:api:type:CartDiscountValueGiftLineItemDraft).
 
-    The quantity cannot be [increased](ctp:api:type:CartChangeLineItemQuantityAction), and it won't be merged when the same Line Item is [added](ctp:api:type:CartAddLineItemAction) to the Cart.
+    The quantity cannot be [increased](ctp:api:type:CartChangeLineItemQuantityAction), and it won't be merged when [adding](ctp:api:type:CartAddLineItemAction) the same Line Item to the Cart.
     If the gift is [removed](ctp:api:type:CartRemoveLineItemAction), an entry is added to the `refusedGifts` array and the discount won't be applied to the Cart.
     The price cannot be changed [externally](ctp:api:type:CartSetLineItemTotalPriceAction).