Skip to content

Commit 5efb179

Browse files
committed
DOC-473: Enter review comments
1 parent d101799 commit 5efb179

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright © Magento, Inc. All rights reserved.
22
# See COPYING.txt for license details.
33

4-
type ComparableItem @doc(description: "Defines an item in a compare list.") {
4+
type ComparableItem @doc(description: "Defines an object used to iterate through items for product comparisons.") {
55
uid: ID! @doc(description: "The unique ID of an item in a compare list.")
66
product: ProductInterface! @doc(description: "Details about a product in a compare list.")
77
attributes: [ProductAttribute]! @doc(description: "An array of product attributes that can be used to compare products.")
@@ -17,7 +17,7 @@ type ComparableAttribute @doc(description: "Contains an attribute code that is u
1717
label: String! @doc(description: "The label of the attribute code.")
1818
}
1919

20-
type CompareList @doc(description: "Contains an array of items in a compare list.") {
20+
type CompareList @doc(description: "Contains iterable information such as the array of items, the count, and attributes that represent the compare list.") {
2121
uid: ID! @doc(description: "The unique ID assigned to the compare list.")
2222
items: [ComparableItem] @doc(description: "An array of products to compare.")
2323
attributes: [ComparableAttribute] @doc(description: "An array of attributes that can be used for comparing products.")

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ type CustomerDownloadableProducts @doc(description: "Contains a list of download
1010
}
1111

1212
type CustomerDownloadableProduct @doc(description: "Contains details about a single downloadable product.") {
13-
order_increment_id: String @doc(description: "An incremental ID assigned to the item.")
13+
order_increment_id: String @doc(description: "The unique ID assigned to the item.")
1414
date: String @doc(description: "The date and time the purchase was made.")
1515
status: String @doc(description: "Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`.")
1616
download_url: String @doc(description: "The fully qualified URL to the download file.")
17-
remaining_downloads: String @doc(description: "The number of times the customer can download the product.")
17+
remaining_downloads: String @doc(description: "The remaining number of times the customer can download the product.")
1818
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ type Mutation {
2121
setGuestEmailOnCart(input: SetGuestEmailOnCartInput @doc(description: "An input object that defines a guest email address.")): SetGuestEmailOnCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\SetGuestEmailOnCart") @doc(description:"Assign the email address of a guest to the cart.")
2222
setPaymentMethodAndPlaceOrder(input: SetPaymentMethodAndPlaceOrderInput): PlaceOrderOutput @deprecated(reason: "Should use setPaymentMethodOnCart and placeOrder mutations in single request.") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetPaymentAndPlaceOrder") @doc(description:"Set the cart payment method and convert the cart into an order.")
2323
mergeCarts(source_cart_id: String! @doc(description: "The guest's cart ID before they login."), destination_cart_id: String @doc(description: "The cart ID after the guest logs in.")): Cart! @doc(description:"Transfer the contents of a guest cart into the cart of a logged-in customer.") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\MergeCarts")
24-
placeOrder(input: PlaceOrderInput @doc(description: "An input object that defines the shopper's cart IS.")): PlaceOrderOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\PlaceOrder") @doc(description:"Convert the quote into an order.")
24+
placeOrder(input: PlaceOrderInput @doc(description: "An input object that defines the shopper's cart ID.")): PlaceOrderOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\PlaceOrder") @doc(description:"Convert the quote into an order.")
2525
addProductsToCart(cartId: String! @doc(description: "The cart ID of the shopper."), cartItems: [CartItemInput!]! @doc(description: "An array that defines the products to add to the cart.")): AddProductsToCartOutput @doc(description:"Add any type of product to the cart.") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddProductsToCart")
2626
}
2727

@@ -360,7 +360,7 @@ type SelectedCustomizableOption @doc(description: "Identifies a customized produ
360360
sort_order: Int! @doc(description: "A value indicating the order to display this option.")
361361
}
362362

363-
type SelectedCustomizableOptionValue @doc(description: "Identifies the value of theselected customized option.") {
363+
type SelectedCustomizableOptionValue @doc(description: "Identifies the value of the selected customized option.") {
364364
id: Int! @deprecated(reason: "Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.")
365365
customizable_option_value_uid: ID! @doc(description: "The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute.")
366366
label: String! @doc(description: "The display name of the selected value.")

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type ReorderItemsOutput @doc(description:"Contains the cart and any errors after
1515
}
1616

1717
type CheckoutUserInputError @doc(description:"An error encountered while adding an item to the cart."){
18-
message: String! @doc(description: "A ocalized error message.")
18+
message: String! @doc(description: "A localized error message.")
1919
path: [String]! @doc(description: "The 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")
2020
code: CheckoutUserInputErrorCodes! @doc(description: "An error code that is specific to Checkout.")
2121
}

0 commit comments

Comments
 (0)