DOC-474: Last major revisions before review

Author: keharper

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

@@ -2,7 +2,7 @@
 # See COPYING.txt for license details.
 
 type Mutation {
-    addBundleProductsToCart(input: AddBundleProductsToCartInput): AddBundleProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") @doc(description: "Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead.")
+    addBundleProductsToCart(input: AddBundleProductsToCartInput @doc(description: "An input object that defines which bundle products to add to the cart.")): AddBundleProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") @doc(description: "Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead.")
 }
 
 input AddBundleProductsToCartInput @doc(description: "Defines the bundle products to add to the cart.") {

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

@@ -3,7 +3,7 @@
 
 type Query {
     products (
-        search: String @doc(description: "One or more strings to use to perform a full-text search."),
+        search: String @doc(description: "One or more keywords to use in a full-text search."),
         filter: ProductAttributeFilterInput @doc(description: "The product attributes to search for and return."),
         pageSize: Int = 20 @doc(description: "The maximum number of results to return at once. The default value is 20."),
         currentPage: Int = 1 @doc(description: "The page of results to return. The default value is 1."),

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

@@ -2,8 +2,8 @@
 # See COPYING.txt for license details.
 
 interface ProductInterface {
-    only_x_left_in_stock: Float @doc(description: "The value assigned to the Only X Left Threshold in the Admin.") @resolver(class: "Magento\\CatalogInventoryGraphQl\\Model\\Resolver\\OnlyXLeftInStockResolver")
-    stock_status: ProductStockStatus @doc(description: "Stock status of the product.") @resolver(class: "Magento\\CatalogInventoryGraphQl\\Model\\Resolver\\StockStatusProvider")
+    only_x_left_in_stock: Float @doc(description: "The value assigned to the Only X Left Threshold option in the Admin.") @resolver(class: "Magento\\CatalogInventoryGraphQl\\Model\\Resolver\\OnlyXLeftInStockResolver")
+    stock_status: ProductStockStatus @doc(description: "The stock status of the product.") @resolver(class: "Magento\\CatalogInventoryGraphQl\\Model\\Resolver\\StockStatusProvider")
 }
 
 enum ProductStockStatus @doc(description: "States whether a product stock status is in stock or out of stock.") {

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

@@ -1,16 +1,16 @@
 # Copyright © Magento, Inc. All rights reserved.
 # See COPYING.txt for license details.
 type Mutation {
-    addConfigurableProductsToCart(input: AddConfigurableProductsToCartInput): AddConfigurableProductsToCartOutput @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\AddConfigurableProductsToCart") @doc(description: "Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead.")
+    addConfigurableProductsToCart(input: AddConfigurableProductsToCartInput @doc(description: "An input object that defines which configurable products to add to the cart.")): AddConfigurableProductsToCartOutput @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\AddConfigurableProductsToCart") @doc(description: "Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead.")
 }
 
 type ConfigurableProduct implements ProductInterface, RoutableInterface, PhysicalProductInterface, CustomizableProductInterface @doc(description: "Defines basic features of a configurable product and its simple product variants.") {
     variants: [ConfigurableVariant] @doc(description: "An array of simple product variants.") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\ConfigurableVariant")
     configurable_options: [ConfigurableProductOptions] @doc(description: "An array of options for the configurable product.") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Options")
-    configurable_product_options_selection(configurableOptionValueUids: [ID!]): ConfigurableProductOptionsSelection @doc(description: "Contains media gallery items and other details about selected configurable product options as well as details about remaining selectable options.") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\OptionsSelectionMetadata")
+    configurable_product_options_selection(configurableOptionValueUids: [ID!]): ConfigurableProductOptionsSelection @doc(description: "An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options.") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\OptionsSelectionMetadata")
 }
 
-type ConfigurableVariant @doc(description: "An array containing all the simple product variants of a configurable product.") {
+type ConfigurableVariant @doc(description: "Contains all the simple product variants of a configurable product.") {
     attributes: [ConfigurableAttributeOption] @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Variant\\Attributes") @doc(description: "An array of configurable attribute options.")
     product: SimpleProduct @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product") @doc(description: "An array of linked simple products.")
 }
@@ -19,7 +19,7 @@ type ConfigurableAttributeOption @doc(description: "Contains details about a con
     label: String @doc(description: "A string that describes the configurable attribute option.")
     code: String @doc(description: "The ID assigned to the attribute.")
     value_index: Int @doc(description: "A unique index number assigned to the configurable product option.")
-    uid: ID! @doc(description: "The unique ID for a `ConfigurableAttributeOption` object") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Variant\\Attributes\\ConfigurableAttributeUid")
+    uid: ID! @doc(description: "The unique ID for a `ConfigurableAttributeOption` object.") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Variant\\Attributes\\ConfigurableAttributeUid")
 }
 
 type ConfigurableProductOptions @doc(description: "Defines configurable attributes for the specified product.") {
@@ -29,7 +29,7 @@ type ConfigurableProductOptions @doc(description: "Defines configurable attribut
     attribute_id_v2: Int @deprecated(reason: "Use `attribute_uid` instead.") @doc(description: "The ID assigned to the attribute.")
     attribute_uid: ID! @doc(description: "The unique ID for an `Attribute` object.")
     attribute_code: String @doc(description: "A string that identifies the attribute.")
-    label: String @doc(description: "A string that describes the configurable product option, which is displayed on the storefront.")
+    label: String @doc(description: "A displayed string that describes the configurable product option.")
     position: Int @doc(description: "A number that indicates the order in which the attribute is displayed.")
     use_default: Boolean @doc(description: "Indicates whether the option is the default.")
     values: [ConfigurableProductOptionsValues] @doc(description: "An array that defines the `value_index` codes assigned to the configurable product.")
@@ -70,7 +70,7 @@ type ConfigurableCartItem implements CartItemInterface @doc(description: "An imp
 type SelectedConfigurableOption @doc(description: "Contains details about a selected configurable option.") {
     id: Int! @deprecated(reason: "Use `SelectedConfigurableOption.configurable_product_option_uid` instead.")
     configurable_product_option_uid: ID! @doc(description: "The unique ID for a `ConfigurableProductOptions` object.")
-    option_label: String! @doc(description: "")
+    option_label: String! @doc(description: "The display text for the option.")
     value_id: Int! @deprecated(reason: "Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.")
     configurable_product_option_value_uid: ID! @doc(description: "The unique ID for a `ConfigurableProductOptionsValues` object.")
     value_label: String! @doc(description: "The display name of the selected configurable option.")
@@ -81,19 +81,19 @@ type ConfigurableWishlistItem implements WishlistItemInterface @doc(description:
     configurable_options: [SelectedConfigurableOption!] @resolver(class: "\\Magento\\ConfigurableProductGraphQl\\Model\\Wishlist\\ConfigurableOptions") @doc(description: "An array of selected configurable options.")
 }
 
-type ConfigurableProductOptionsSelection @doc(description: "Contains metadata corresponding to the configurable options selection.") {
-    options_available_for_selection: [ConfigurableOptionAvailableForSelection!] @doc(description: "Configurable options available for further selection based on the current selection.")
-    configurable_options: [ConfigurableProductOption!] @doc(description: "Configurable options available for further selection based on the current selections.")
+type ConfigurableProductOptionsSelection @doc(description: "Contains metadata corresponding to the selected configurable options.") {
+    options_available_for_selection: [ConfigurableOptionAvailableForSelection!] @doc(description: "The configurable options available for further selection based on the current selection.")
+    configurable_options: [ConfigurableProductOption!] @doc(description: "An array of all possible configurable options.")
     media_gallery: [MediaGalleryInterface!] @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\SelectionMediaGallery") @doc(description: "Product images and videos corresponding to the specified configurable options selection.")
-    variant: SimpleProduct @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Variant\\Variant") @doc(description: "A variant represented by the specified configurable options selection. It is expected to be null, until selections are made for each configurable option.")
+    variant: SimpleProduct @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Variant\\Variant") @doc(description: "A variant represented by the specified configurable options selection. The value is expected to be null until selections are made for each configurable option.")
 }
 
 type ConfigurableOptionAvailableForSelection @doc(description: "Describes configurable options that have been selected and can be selected as a result of the previous selections.") {
-    option_value_uids: [ID!]! @doc(description: "An array of IDs that can be selected.")
+    option_value_uids: [ID!]! @doc(description: "An array of selectable option value IDs.")
     attribute_code: String! @doc(description: "An attribute code that uniquely identifies a configurable option.")
 }
 
-type ConfigurableProductOption @doc(description: "Contains configurable options available for further selected, based on the current selections.") {
+type ConfigurableProductOption @doc(description: "Contains details about configurable product options.") {
     uid: ID! @doc(description: "The unique ID of the configurable option.")
     attribute_code: String! @doc(description: "An attribute code that uniquely identifies a configurable option.")
     label: String! @doc(description: "The display name of the option.")
@@ -108,5 +108,5 @@ type ConfigurableProductOptionValue @doc(description: "Defines a value for a con
 }
 
 type StoreConfig {
-    configurable_thumbnail_source : String @doc(description: "The configuration setting determines which thumbnail should be used in the cart for configurable products.")
+    configurable_thumbnail_source : String @doc(description: "Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products.")
 }

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

@@ -2,7 +2,7 @@
 # See COPYING.txt for license details.
 
 type Mutation {
-    addDownloadableProductsToCart(input: AddDownloadableProductsToCartInput): AddDownloadableProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") @doc(description: "Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead.")
+    addDownloadableProductsToCart(input: AddDownloadableProductsToCartInput @doc(description: "An input object that defines which downloadable products to add to the cart.")): AddDownloadableProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") @doc(description: "Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead.")
 }
 
 input AddDownloadableProductsToCartInput {
@@ -47,7 +47,7 @@ type DownloadableProductLinks @doc(description: "Defines characteristics of a do
     title: String @doc(description: "The display name of the link.")
     sort_order: Int @doc(description: "A number indicating the sort order.")
     price: Float @doc(description: "The price of the downloadable product.")
-    sample_url: String @doc(description: "URL to the downloadable sample.")
+    sample_url: String @doc(description: "The full URL to the downloadable sample.")
     is_shareable: Boolean @deprecated(reason: "This information should not be exposed on frontend.")
     number_of_downloads: Int @deprecated(reason: "This information should not be exposed on frontend.")
     link_type: DownloadableFileTypeEnum @deprecated(reason: "Use `sample_url` instead.")
@@ -60,7 +60,7 @@ type DownloadableProductSamples @doc(description: "Defines characteristics of a
     id: Int @deprecated(reason: "This information should not be exposed on frontend.")
     title: String @doc(description: "The display name of the sample.")
     sort_order: Int @doc(description: "A number indicating the sort order.")
-    sample_url: String @doc(description: "URL to the downloadable sample.")
+    sample_url: String @doc(description: "The full URL to the downloadable sample.")
     sample_type: DownloadableFileTypeEnum @deprecated(reason: "Use `sample_url` instead.")
     sample_file: String @deprecated(reason: "Use `sample_url` instead.")
 }

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

@@ -2,7 +2,7 @@
 # See COPYING.txt for license details.
 
 interface ProductInterface {
-    related_products: [ProductInterface] @doc(description: "Related Products") @resolver(class: "Magento\\RelatedProductGraphQl\\Model\\Resolver\\Batch\\RelatedProducts")
-    upsell_products: [ProductInterface] @doc(description: "Upsell Products")  @resolver(class: "Magento\\RelatedProductGraphQl\\Model\\Resolver\\Batch\\UpSellProducts")
-    crosssell_products: [ProductInterface] @doc(description: "Crosssell Products") @resolver(class: "Magento\\RelatedProductGraphQl\\Model\\Resolver\\Batch\\CrossSellProducts")
+    related_products: [ProductInterface] @doc(description: "An array of products to be displayed in a Related Products block.") @resolver(class: "Magento\\RelatedProductGraphQl\\Model\\Resolver\\Batch\\RelatedProducts")
+    upsell_products: [ProductInterface] @doc(description: "Upsell Products")  @resolver(class: "Magento\\RelatedProductGraphQl\\Model\\Resolver\\Batch\\UpSellProducts") @doc(description: "An array of products to be displayed in a Upsell Products block.") 
+    crosssell_products: [ProductInterface] @doc(description: "Crosssell Products") @resolver(class: "Magento\\RelatedProductGraphQl\\Model\\Resolver\\Batch\\CrossSellProducts") @doc(description: "An array of products to be displayed in a Cross-sell Products block.") 
 }