DOC-473: Minor corrections and updates

Author: keharper

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

@@ -4,22 +4,22 @@
 type StoreConfig {
     required_character_classes_number : String @doc(description: "The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.")
     minimum_password_length : String @doc(description: "The minimum number of characters required for a valid password.")
-    autocomplete_on_storefront : Boolean @doc(description: "Whether to enable autocomplete on login and forgot password forms.")
+    autocomplete_on_storefront : Boolean @doc(description: "Indicates whether to enable autocomplete on login and forgot password forms.")
 }
 
 type Query {
     customer: Customer @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\Customer") @doc(description: "Return detailed information about a customer account.") @cache(cacheable: false)
     isEmailAvailable (
-        email: String! @doc(description: "Check whether the specified email has already been used to create a customer account.")
-    ): IsEmailAvailableOutput @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\IsEmailAvailable")
+        email: String! @doc(description: "The email address to check.")
+    ): IsEmailAvailableOutput @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\IsEmailAvailable") @doc(description: "Check whether the specified email has already been used to create a customer account.")
 }
 
 type Mutation {
     generateCustomerToken(email: String!, password: String!): CustomerToken @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\GenerateCustomerToken") @doc(description:"Generate a token for specified customer.")
     changeCustomerPassword(currentPassword: String!, newPassword: String!): Customer @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ChangePassword") @doc(description:"Change the password for the logged-in customer.")
     createCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Use createCustomerV2 instead.")
     createCustomerV2 (input: CustomerCreateInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Create a customer account.")
-    updateCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Deprecated. Use UpdateCustomerV2 instead.")
+    updateCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Use UpdateCustomerV2 instead.")
     updateCustomerV2 (input: CustomerUpdateInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Update the customer's personal information.")
     revokeCustomerToken: RevokeCustomerTokenOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RevokeCustomerToken") @doc(description:"Revoke the customer token.")
     createCustomerAddress(input: CustomerAddressInput!): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomerAddress") @doc(description: "Create a billing or shipping address for a customer or guest.")
@@ -44,7 +44,7 @@ input CustomerAddressInput @doc(description: "Contains details about a billing o
     default_shipping: Boolean @doc(description: "Indicates whether the address is the default shipping address.")
     default_billing: Boolean @doc(description: "Indicates whether the address is the default billing address.")
     fax: String @doc(description: "The customer's fax number.")
-    middlename: String @doc(description: "The middle name of the person associated with the shipping/billing address.")
+    middlename: String @doc(description: "The middle name of the person associated with the billing/shipping address.")
     prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
     suffix: String @doc(description: "A value such as Sr., Jr., or III.")
     vat_id: String @doc(description: "The customer's Tax/VAT number (for corporate customers).")
@@ -110,7 +110,7 @@ input CustomerUpdateInput @doc(description: "An input object for updating a cust
 }
 
 type CustomerOutput @doc(description: "Contains details about a newly-created or updated customer.") {
-    customer: Customer! @doc(description: "Contains the `Customer` object.")
+    customer: Customer! @doc(description: "Customer details after creating or updating a customer.")
 }
 
 type RevokeCustomerTokenOutput @doc(description: "Contains the result of a request to revoke a customer token.") {
@@ -143,7 +143,7 @@ type CustomerAddress @doc(description: "Contains detailed information about a cu
     region: CustomerAddressRegion @doc(description: "An object containing the region name, region code, and region ID.")
     region_id: Int @doc(description: "The unique ID for a pre-defined region.")
     country_id: String @doc(description: "The customer's country.") @deprecated(reason: "Use `country_code` instead.")
-    country_code: CountryCodeEnum @doc(description: "The customer's country")
+    country_code: CountryCodeEnum @doc(description: "The customer's country.")
     street: [String] @doc(description: "An array of strings that define the street number and name.")
     company: String @doc(description: "The customer's company.")
     telephone: String @doc(description: "The customer's telephone number.")

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

@@ -12,16 +12,16 @@ type Mutation {
     addVirtualProductsToCart(input: AddVirtualProductsToCartInput): AddVirtualProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") @doc(description:"Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead.")
     applyCouponToCart(input: ApplyCouponToCartInput): ApplyCouponToCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ApplyCouponToCart") @doc(description:"Apply a pre-defined coupon code to the specified cart.")
     removeCouponFromCart(input: RemoveCouponFromCartInput): RemoveCouponFromCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\RemoveCouponFromCart") @doc(description:"Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.")
-    updateCartItems(input: UpdateCartItemsInput): UpdateCartItemsOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\UpdateCartItems") @doc(description:"Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.")
+    updateCartItems(input: UpdateCartItemsInput): UpdateCartItemsOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\UpdateCartItems") @doc(description:"Modify items in the cart.")
     removeItemFromCart(input: RemoveItemFromCartInput): RemoveItemFromCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\RemoveItemFromCart") @doc(description:"Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.")
     setShippingAddressesOnCart(input: SetShippingAddressesOnCartInput): SetShippingAddressesOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetShippingAddressesOnCart") @doc(description:"Set one or more shipping addresses on a specific cart.")
     setBillingAddressOnCart(input: SetBillingAddressOnCartInput): SetBillingAddressOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetBillingAddressOnCart") @doc(description:"Set the billing address on a specific cart.")
     setShippingMethodsOnCart(input: SetShippingMethodsOnCartInput): SetShippingMethodsOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetShippingMethodsOnCart") @doc(description:"Set one or more delivery methods on a cart.")
     setPaymentMethodOnCart(input: SetPaymentMethodOnCartInput): SetPaymentMethodOnCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\SetPaymentMethodOnCart") @doc(description:"Apply a payment method to the cart.")
     setGuestEmailOnCart(input: SetGuestEmailOnCartInput): SetGuestEmailOnCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\SetGuestEmailOnCart") @doc(description:"Assign the email address of a guest to the cart.")
     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.")
-    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") @doc(description:"Transfer the contents of a guest cart into the cart of a logged-in customer.")
-    placeOrder(input: PlaceOrderInput): PlaceOrderOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\PlaceOrder") @doc(description:"Convert the cart into an order.")
+    mergeCarts(source_cart_id: String!, destination_cart_id: String): 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")
+    placeOrder(input: PlaceOrderInput): PlaceOrderOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\PlaceOrder") @doc(description:"Convert the quote into an order.")
     addProductsToCart(cartId: String!, cartItems: [CartItemInput!]!): AddProductsToCartOutput @doc(description:"Add any type of product to the cart.") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddProductsToCart")
 }
 
@@ -74,7 +74,7 @@ input UpdateCartItemsInput @doc(description: "Modifies the specified items in th
 
 input CartItemUpdateInput @doc(description: "A single item to be updated.") {
     cart_item_id: Int @doc(description: "Deprecated. Use `cart_item_uid` instead.")
-    cart_item_uid: ID @doc(description: "The unique ID for a `CartItemInterface` object")
+    cart_item_uid: ID @doc(description: "The unique ID for a `CartItemInterface` object.")
     quantity: Float @doc(description: "The new quantity of the item.")
     customizable_options: [CustomizableOptionInput!] @doc(description: "An array that defines customizable options for the product.")
 }
@@ -210,7 +210,7 @@ type Cart @doc(description: "Contains the contents and other details about a gue
     billing_address: BillingCartAddress @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\BillingAddress") @doc(description: "The billing address assigned to the cart.")
     available_payment_methods: [AvailablePaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethods") @doc(description: "An array of available payment methods.")
     selected_payment_method: SelectedPaymentMethod @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SelectedPaymentMethod") @doc(description: "Indicates which payment method was applied to the cart.")
-    prices: CartPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartPrices") @doc(description: "Contains pricing details.")
+    prices: CartPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartPrices") @doc(description: "Pricing details for the quote.")
     total_quantity: Float! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartTotalQuantity") @doc(description: "The total number of items in the cart.")
     is_virtual: Boolean! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartIsVirtual") @doc(description: "Indicates whether the cart contains only virtual products.")
 }
@@ -334,7 +334,7 @@ interface CartItemInterface @typeResolver(class: "Magento\\QuoteGraphQl\\Model\\
     uid: ID! @doc(description: "The unique ID for a `CartItemInterface` object.")
     quantity: Float! @doc(description: "The quantity of this item in the cart.")
     prices: CartItemPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") @doc(description: "Contains details about the price of the item, including taxes and discounts.")
-    product: ProductInterface! @doc(description: "Contains details about the item in the cart.")
+    product: ProductInterface! @doc(description: "Details about an item in the cart.")
 }
 
 type Discount @doc(description:"Defines an individual discount. A discount can be applied to the cart as a whole or to an item.") {
@@ -345,7 +345,7 @@ type Discount @doc(description:"Defines an individual discount. A discount can b
 type CartItemPrices @doc(description: "Contains details about the price of the item, including taxes and discounts.") {
     price: Money! @doc(description: "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.")
     row_total: Money! @doc(description: "The value of the price multiplied by the quantity of the item.")
-    row_total_including_tax: Money! @doc(description: "The value of row_total plus the tax applied to the item.")
+    row_total_including_tax: Money! @doc(description: "The value of `row_total` plus the tax applied to the item.")
     discounts: [Discount] @doc(description: "An array of discounts to be applied to the cart item.")
     total_item_discount: Money @doc(description: "The total of all discounts applied to the item.")
 }

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

@@ -15,8 +15,8 @@ type ReorderItemsOutput @doc(description:"Contains the cart and any errors after
 }
 
 type CheckoutUserInputError @doc(description:"An error encountered while adding an item to the cart."){
-    message: String! @doc(description: "Localized error message.")
-    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")
+    message: String! @doc(description: "A ocalized error message.")
+    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")
     code: CheckoutUserInputErrorCodes! @doc(description: "An error code that is specific to Checkout.")
 }
 
@@ -169,8 +169,8 @@ type ShippingDiscount @doc(description:"Defines an individual shipping discount.
 type OrderShipment @doc(description: "Contains order shipment details.") {
     id: ID! @doc(description: "The unique ID for a `OrderShipment` object.")
     number: String! @doc(description: "The sequential credit shipment number.")
-    tracking: [ShipmentTracking] @doc(description: "Contains shipment tracking details.") @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\Shipment\\ShipmentTracking")
-    items: [ShipmentItemInterface] @doc(description: "Contains items included in the shipment.") @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\Shipment\\ShipmentItems")
+    tracking: [ShipmentTracking] @doc(description: "An array of shipment tracking details.") @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\Shipment\\ShipmentTracking")
+    items: [ShipmentItemInterface] @doc(description: "An array of items included in the shipment.") @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\Shipment\\ShipmentItems")
     comments: [SalesCommentItem] @doc(description: "Comments added to the shipment.")
 }
 
@@ -217,7 +217,7 @@ interface CreditMemoItemInterface @doc(description: "Credit memo item details.")
     product_name: String @doc(description: "The name of the base product.")
     product_sku: String! @doc(description: "The SKU of the base product.")
     product_sale_price: Money! @doc(description: "The sale price for the base product, including selected options.")
-    discounts: [Discount] @doc(description: "Information about the final discount amount for the base product, including discounts on options.")
+    discounts: [Discount] @doc(description: "Details about the final discount amount for the base product, including discounts on options.")
     quantity_refunded: Float @doc(description: "The number of refunded items.")
 }
 

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

@@ -17,8 +17,8 @@ type Customer {
 type WishlistOutput @doc(description: "Deprecated: Use the `Wishlist` type instead.") {
     items: [WishlistItem] @deprecated(reason: "Use the `Wishlist.items` field instead.") @resolver(class: "\\Magento\\WishlistGraphQl\\Model\\Resolver\\WishlistItemsResolver") @doc(description: "An array of items in the customer's wish list"),
     items_count: Int @deprecated(reason: "Use the `Wishlist.items_count` field instead.") @doc(description: "The number of items in the wish list."),
-    name: String @deprecated(reason: "This field is related to Commerce functionality and is always `null` in Open Source edition.") @doc(description: "When multiple wish lists are enabled, the name the customer assigns to the wishlist."),
-    sharing_code: String @deprecated(reason: "Use the `Wishlist.sharing_code` field instead.") @doc(description: "An encrypted code that Magento uses to link to the wish list."),
+    name: String @deprecated(reason: "This field is related to Commerce functionality and is always `null` in Open Source.") @doc(description: "When multiple wish lists are enabled, the name the customer assigns to the wishlist."),
+    sharing_code: String @deprecated(reason: "Use the `Wishlist.sharing_code` field instead.") @doc(description: "An encrypted code that links to the wish list."),
     updated_at: String @deprecated(reason: "Use the `Wishlist.updated_at` field instead.") @doc(description: "The time of the last modification to the wish list.")
 }