DOC-473: Updates descriptions for cart_id

keharper · keharper · commit a89a74ac9823 · 2021-09-07T17:10:45.000-05:00
diff --git a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls
@@ -2,7 +2,7 @@
 # See COPYING.txt for license details.
 
 type Query {
-    cart(cart_id: String! @doc(description: "The masked ID of the cart to query.")): Cart @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Cart") @doc(description:"Return information about the specified shopping cart.") @cache(cacheable: false)
+    cart(cart_id: String! @doc(description: "The unique ID of the cart to query.")): Cart @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Cart") @doc(description:"Return information about the specified shopping cart.") @cache(cacheable: false)
     customerCart: Cart! @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CustomerCart") @doc(description:"Return information about the customer's shopping cart.") @cache(cacheable: false)
 }
 
@@ -30,7 +30,7 @@ input createEmptyCartInput @doc(description: "Assigns a specific `cart_id` to th
 }
 
 input AddSimpleProductsToCartInput @doc(description: "Defines the simple and group products to add to the cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     cart_items: [SimpleProductCartItemInput!]! @doc(description: "An array of simple and group items to add.")
 }
 
@@ -40,7 +40,7 @@ input SimpleProductCartItemInput @doc(description: "Defines a single product to
 }
 
 input AddVirtualProductsToCartInput @doc(description: "Defines the virtual products to add to the cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     cart_items: [VirtualProductCartItemInput!]! @doc(description: "An array of virtual products to add.")
 }
 
@@ -63,12 +63,12 @@ input CustomizableOptionInput @doc(description: "Defines a customizable option."
 }
 
 input ApplyCouponToCartInput @doc(description: "Specifies the coupon code to apply to the cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     coupon_code: String! @doc(description: "A valid coupon code.")
 }
 
 input UpdateCartItemsInput @doc(description: "Modifies the specified items in the cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     cart_items: [CartItemUpdateInput!]! @doc(description: "An array of items to be updated.")
 }
 
@@ -80,13 +80,13 @@ input CartItemUpdateInput @doc(description: "A single item to be updated.") {
 }
 
 input RemoveItemFromCartInput @doc(description: "Specifies which items to remove from the cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     cart_item_id: Int @doc(description: "Deprecated. Use `cart_item_uid` instead.")
     cart_item_uid: ID @doc(description: "Required field. The unique ID for a `CartItemInterface` object.")
 }
 
 input SetShippingAddressesOnCartInput @doc(description: "Specifies an array of addresses to use for shipping.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     shipping_addresses: [ShippingAddressInput!]! @doc(description: "An array of shipping addresses.")
 }
 
@@ -97,7 +97,7 @@ input ShippingAddressInput @doc(description: "Defines a single shipping address.
 }
 
 input SetBillingAddressOnCartInput @doc(description: "Sets the billing address.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     billing_address: BillingAddressInput! @doc(description: "The billing address.")
 }
 
@@ -123,7 +123,7 @@ input CartAddressInput @doc(description: "Defines the billing or shipping addres
 }
 
 input SetShippingMethodsOnCartInput @doc(description: "Applies one or shipping methods to the cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     shipping_methods: [ShippingMethodInput!]! @doc(description: "An array of shipping methods.")
 }
 
@@ -133,16 +133,16 @@ input ShippingMethodInput @doc(description: "Defines the shipping carrier and me
 }
 
 input SetPaymentMethodAndPlaceOrderInput @doc(description: "Applies a payment method to the quote.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     payment_method: PaymentMethodInput! @doc(description: "The payment method data to apply to the cart.")
 }
 
 input PlaceOrderInput @doc(description: "Specifies the quote to be converted to an order.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
 }
 
 input SetPaymentMethodOnCartInput @doc(description: "Applies a payment method to the cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     payment_method: PaymentMethodInput! @doc(description: "The payment method data to apply to the cart.")
 }
 
@@ -152,7 +152,7 @@ input PaymentMethodInput @doc(description: "Defines the payment method.") {
 }
 
 input SetGuestEmailOnCartInput @doc(description: "Defines the guest email and cart.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
     email: String! @doc(description: "The email address of the guest.")
 }
 
@@ -294,7 +294,7 @@ type AppliedCoupon @doc(description: "Contains the applied coupon code.") {
 }
 
 input RemoveCouponFromCartInput @doc(description: "Specifies the cart from which to remove a coupon.") {
-    cart_id: String! @doc(description: "The ID of the cart.")
+    cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
 }
 
 type RemoveCouponFromCartOutput @doc(description: "Contains details about the cart after removing a coupon.") {

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`# See COPYING.txt for license details.`
`3`	`3`
`4`	`4`	`type Query {`
`5`		`- cart(cart_id: String! @doc(description: "The masked ID of the cart to query.")): Cart @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Cart") @doc(description:"Return information about the specified shopping cart.") @cache(cacheable: false)`
	`5`	`+ cart(cart_id: String! @doc(description: "The unique ID of the cart to query.")): Cart @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Cart") @doc(description:"Return information about the specified shopping cart.") @cache(cacheable: false)`
`6`	`6`	`customerCart: Cart! @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CustomerCart") @doc(description:"Return information about the customer's shopping cart.") @cache(cacheable: false)`
`7`	`7`	`}`
`8`	`8`
@@ -30,7 +30,7 @@ input createEmptyCartInput @doc(description: "Assigns a specific `cart_id` to th
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`input AddSimpleProductsToCartInput @doc(description: "Defines the simple and group products to add to the cart.") {`
`33`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`33`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`34`	`34`	`cart_items: [SimpleProductCartItemInput!]! @doc(description: "An array of simple and group items to add.")`
`35`	`35`	`}`
`36`	`36`
`@@ -40,7 +40,7 @@ input SimpleProductCartItemInput @doc(description: "Defines a single product to`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`input AddVirtualProductsToCartInput @doc(description: "Defines the virtual products to add to the cart.") {`
`43`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`43`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`44`	`44`	`cart_items: [VirtualProductCartItemInput!]! @doc(description: "An array of virtual products to add.")`
`45`	`45`	`}`
`46`	`46`
`@@ -63,12 +63,12 @@ input CustomizableOptionInput @doc(description: "Defines a customizable option."`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`input ApplyCouponToCartInput @doc(description: "Specifies the coupon code to apply to the cart.") {`
`66`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`66`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`67`	`67`	`coupon_code: String! @doc(description: "A valid coupon code.")`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`input UpdateCartItemsInput @doc(description: "Modifies the specified items in the cart.") {`
`71`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`71`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`72`	`72`	`cart_items: [CartItemUpdateInput!]! @doc(description: "An array of items to be updated.")`
`73`	`73`	`}`
`74`	`74`
`@@ -80,13 +80,13 @@ input CartItemUpdateInput @doc(description: "A single item to be updated.") {`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`input RemoveItemFromCartInput @doc(description: "Specifies which items to remove from the cart.") {`
`83`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`83`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`84`	`84`	cart_item_id: Int @doc(description: "Deprecated. Use `cart_item_uid` instead.")
`85`	`85`	cart_item_uid: ID @doc(description: "Required field. The unique ID for a `CartItemInterface` object.")
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`input SetShippingAddressesOnCartInput @doc(description: "Specifies an array of addresses to use for shipping.") {`
`89`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`89`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`90`	`90`	`shipping_addresses: [ShippingAddressInput!]! @doc(description: "An array of shipping addresses.")`
`91`	`91`	`}`
`92`	`92`
`@@ -97,7 +97,7 @@ input ShippingAddressInput @doc(description: "Defines a single shipping address.`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`input SetBillingAddressOnCartInput @doc(description: "Sets the billing address.") {`
`100`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`100`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`101`	`101`	`billing_address: BillingAddressInput! @doc(description: "The billing address.")`
`102`	`102`	`}`
`103`	`103`
`@@ -123,7 +123,7 @@ input CartAddressInput @doc(description: "Defines the billing or shipping addres`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`input SetShippingMethodsOnCartInput @doc(description: "Applies one or shipping methods to the cart.") {`
`126`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`126`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`127`	`127`	`shipping_methods: [ShippingMethodInput!]! @doc(description: "An array of shipping methods.")`
`128`	`128`	`}`
`129`	`129`
`@@ -133,16 +133,16 @@ input ShippingMethodInput @doc(description: "Defines the shipping carrier and me`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`input SetPaymentMethodAndPlaceOrderInput @doc(description: "Applies a payment method to the quote.") {`
`136`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`136`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`137`	`137`	`payment_method: PaymentMethodInput! @doc(description: "The payment method data to apply to the cart.")`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`input PlaceOrderInput @doc(description: "Specifies the quote to be converted to an order.") {`
`141`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`141`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`input SetPaymentMethodOnCartInput @doc(description: "Applies a payment method to the cart.") {`
`145`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`145`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`146`	`146`	`payment_method: PaymentMethodInput! @doc(description: "The payment method data to apply to the cart.")`
`147`	`147`	`}`
`148`	`148`
`@@ -152,7 +152,7 @@ input PaymentMethodInput @doc(description: "Defines the payment method.") {`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`input SetGuestEmailOnCartInput @doc(description: "Defines the guest email and cart.") {`
`155`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`155`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`156`	`156`	`email: String! @doc(description: "The email address of the guest.")`
`157`	`157`	`}`
`158`	`158`
`@@ -294,7 +294,7 @@ type AppliedCoupon @doc(description: "Contains the applied coupon code.") {`
`294`	`294`	`}`
`295`	`295`
`296`	`296`	`input RemoveCouponFromCartInput @doc(description: "Specifies the cart from which to remove a coupon.") {`
`297`		`- cart_id: String! @doc(description: "The ID of the cart.")`
	`297`	+ cart_id: String! @doc(description: "The unique ID of a `Cart` object.")
`298`	`298`	`}`
`299`	`299`
`300`	`300`	`type RemoveCouponFromCartOutput @doc(description: "Contains details about the cart after removing a coupon.") {`