Skip to content

Commit f6cfcff

Browse files
author
Prabhu Ram
committed
- Updated schema descriptions
1 parent 330e763 commit f6cfcff

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

app/code/Magento/QuoteGraphQl/etc/schema.graphqls

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ type Mutation {
2222
setPaymentMethodAndPlaceOrder(input: SetPaymentMethodAndPlaceOrderInput): PlaceOrderOutput @deprecated(reason: "Should use setPaymentMethodOnCart and placeOrder mutations in single request.") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetPaymentAndPlaceOrder")
2323
mergeCarts(source_cart_id: String!, destination_cart_id: String!): Cart! @doc(description:"Merges the source cart into the destination cart") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\MergeCarts")
2424
placeOrder(input: PlaceOrderInput): PlaceOrderOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\PlaceOrder")
25-
addProductsToCart(cartId: String!, cartItems: [CartItemInput!]!): AddProductsToCartOutput @doc(description:"Add products to the cart. Provide single interface for all product types ") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddProductsToCart")
25+
addProductsToCart(cartId: String!, cartItems: [CartItemInput!]!): AddProductsToCartOutput @doc(description:"Add any type of product to the cart") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddProductsToCart")
2626
}
2727

2828
input createEmptyCartInput {
@@ -52,9 +52,9 @@ input VirtualProductCartItemInput {
5252
input CartItemInput {
5353
sku: String!
5454
quantity: Float!
55-
parent_sku: String,
56-
selected_options: [ID!]
57-
entered_options: [EnteredOptionInput!]
55+
parent_sku: String @doc(description: "For child products, the SKU of its parent product")
56+
selected_options: [ID!] @doc(description: "The selected options for the base product, such as color or size")
57+
entered_options: [EnteredOptionInput!] @doc(description: "An array of entered options for the base product, such as personalization text")
5858
}
5959

6060
input CustomizableOptionInput {
@@ -373,15 +373,15 @@ type Order {
373373
order_id: String @deprecated(reason: "The order_id field is deprecated, use order_number instead.")
374374
}
375375

376-
type CheckoutUserInputError @doc(description:"An error encountered while adding an item the the cart.") {
377-
message: String! @doc(description: "Localized error message")
376+
type CheckoutUserInputError @doc(description:"An error encountered while adding an item to the the cart.") {
377+
message: String! @doc(description: "A localized error message")
378378
path: [String]! @doc(description: "Path to the input field that caused an error. See the GraphQL specification about path errors for details: http://spec.graphql.org/draft/#sec-Errors")
379379
code: CheckoutUserInputErrorCodes! @doc(description: "Checkout-specific error code")
380380
}
381381

382382
type AddProductsToCartOutput {
383-
cart: Cart!
384-
userInputErrors:[CheckoutUserInputError]!
383+
cart: Cart! @doc(description: "The cart after products have been added")
384+
userInputErrors:[CheckoutUserInputError]! @doc(description: "An error encountered while adding an item to the cart.")
385385
}
386386

387387
enum CheckoutUserInputErrorCodes {

0 commit comments

Comments
 (0)