DOC-475: Enter review comments

Author: keharper

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

@@ -5,10 +5,10 @@ type Query {
     checkoutAgreements: [CheckoutAgreement] @resolver(class: "Magento\\CheckoutAgreementsGraphQl\\Model\\Resolver\\CheckoutAgreements") @doc(description: "Return Terms and Conditions configuration information.")
 }
 
-type CheckoutAgreement @doc(description: "Contains details about an individual checkout agreement.") {
-    agreement_id: Int! @doc(description: "The identifier for a checkout agreement.")
+type CheckoutAgreement @doc(description: "Defines details about an individual checkout agreement.") {
+    agreement_id: Int! @doc(description: "The ID for a checkout agreement.")
     name: String! @doc(description: "The name given to the condition.")
-    content: String! @doc(description: "The text of the agreement.")
+    content: String! @doc(description: "Required. The text of the agreement.")
     content_height: String @doc(description: "The height of the text box where the Terms and Conditions statement appears during checkout.")
     checkbox_text: String! @doc(description: "The checkbox text for the checkout agreement.")
     is_html: Boolean! @doc(description: "Indicates whether the `content` text is in HTML format.")
@@ -17,5 +17,5 @@ type CheckoutAgreement @doc(description: "Contains details about an individual c
 
 enum CheckoutAgreementMode @doc(description: "Indicates how agreements are accepted.") {
     AUTO @doc(description: "Conditions are automatically accepted upon checkout.")
-    MANUAL @doc(description: "Shoppers are required to manually accept the conditions to place an order.")
+    MANUAL @doc(description: "Shoppers must manually accept the conditions to place an order.")
 }

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

@@ -37,7 +37,7 @@ type AttributeOption @doc(description: "Defines an attribute option.") {
     value: String @doc(description: "The attribute option value.")
 }
 
-input AttributeInput @doc(description: "Specifies the `attribute_code` and `entity_type` to search.") {
+input AttributeInput @doc(description: "Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search.") {
     attribute_code: String @doc(description: "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.")
     entity_type: String @doc(description: "The type of entity that defines the attribute.")
 }

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

@@ -50,7 +50,7 @@ type Mutation {
 input FilterTypeInput @doc(description: "Defines the comparison operators that can be used in a filter.") {
     eq: String @doc(description: "Equals.")
     finset: [String] @deprecated (reason: "We do not recommend storing comma separated values, therefore the `finset` filter is redundant.")
-    from: String @doc(description: "From. Must be used with `to`.")
+    from: String @doc(description: "From. Must be used with the `to` field.")
     gt: String @doc(description: "Greater than.")
     gteq: String @doc(description: "Greater than or equal to.")
     in: [String] @doc(description: "In. The value can contain a set of comma-separated values.")
@@ -61,7 +61,7 @@ input FilterTypeInput @doc(description: "Defines the comparison operators that c
     neq: String @doc(description: "Not equal to.")
     notnull: String @doc(description: "Not null.")
     null: String @doc(description: "Is null.")
-    to: String@doc(description: "To. Must be used with `from`.")
+    to: String@doc(description: "To. Must be used with the `from` field.")
     nin: [String] @doc(description: "Not in. The value can contain a set of comma-separated values.")
 }
 
@@ -97,7 +97,7 @@ enum SortEnum @doc(description: "Indicates whether to return results in ascendin
 }
 
 type ComplexTextValue {
-    html: String! @doc(description: "Text that can contain HTML formatting.")
+    html: String! @doc(description: "Text that can contain HTML tags.")
 }
 
 type Money @doc(description: "Defines a monetary value, including a numeric value and a currency code.") {

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

@@ -2,10 +2,10 @@
 # See COPYING.txt for license details.
 
 type Mutation {
-    subscribeEmailToNewsletter(email: String! @doc(description: "The email address to subscribe.")): SubscribeEmailToNewsletterOutput @doc(description:"Subscribe the specified email to the store's newsletter.") @resolver(class: "Magento\\NewsletterGraphQl\\Model\\Resolver\\SubscribeEmailToNewsletter")
+    subscribeEmailToNewsletter(email: String! @doc(description: "The email address that will receive the store's newsletter.")): SubscribeEmailToNewsletterOutput @doc(description:"Subscribe the specified email to the store's newsletter.") @resolver(class: "Magento\\NewsletterGraphQl\\Model\\Resolver\\SubscribeEmailToNewsletter")
 }
 
-type SubscribeEmailToNewsletterOutput @doc(description: "Contains the status of the request.") {
+type SubscribeEmailToNewsletterOutput @doc(description: "Contains the result of the `subscribeEmailToNewsletter` operation.") {
     status: SubscriptionStatusesEnum @doc(description: "The status of the subscription request.")
 }
 

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

@@ -10,7 +10,7 @@ input ProductFilterInput {
 }
 
 input ProductSortInput {
-    swatch_image: SortEnum @doc(description: "Indicates how to sort the swatches.")
+    swatch_image: SortEnum @doc(description: "Indicates the criteria to sort swatches.")
 }
 
 interface SwatchLayerFilterItemInterface @typeResolver(class: "Magento\\SwatchesGraphQl\\Model\\Resolver\\SwatchLayerFilterItemResolver")
@@ -33,11 +33,11 @@ type ConfigurableProductOptionsValues {
 }
 
 interface SwatchDataInterface @typeResolver(class: "Magento\\SwatchesGraphQl\\Model\\Resolver\\Product\\Options\\SwatchDataTypeResolver") {
-    value: String @doc(description: "The value of a swatch item. It could be a HEX color code, image link, or text value.")
+    value: String @doc(description: "The value can be represented as color (HEX code), image link, or text.")
 }
 
 type ImageSwatchData implements SwatchDataInterface {
-    thumbnail: String @doc(description: "The URL to the thumbnail swatch image.")
+    thumbnail: String @doc(description: "The URL assigned to the thumbnail of the swatch image.")
 }
 
 type TextSwatchData implements SwatchDataInterface {
@@ -49,5 +49,5 @@ type ColorSwatchData implements SwatchDataInterface {
 }
 
 type ConfigurableProductOptionValue {
-    swatch: SwatchDataInterface @resolver(class: "Magento\\SwatchesGraphQl\\Model\\Resolver\\Product\\Options\\SwatchData") @doc(description: "The URL to the thumbnail swatch image.")
+    swatch: SwatchDataInterface @resolver(class: "Magento\\SwatchesGraphQl\\Model\\Resolver\\Product\\Options\\SwatchData") @doc(description: "The URL assigned to the thumbnail of the swatch image.")
 }

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

@@ -2,19 +2,19 @@
 # See COPYING.txt for license details.
 
 type Mutation {
-    deletePaymentToken(public_hash: String! @doc(description: "The public token that is stored in the vault.")): DeletePaymentTokenOutput @resolver(class: "\\Magento\\VaultGraphQl\\Model\\Resolver\\DeletePaymentToken") @doc(description:"Delete a customer's payment token.")
+    deletePaymentToken(public_hash: String! @doc(description: "The reusable payment token securely stored in the vault.")): DeletePaymentTokenOutput @resolver(class: "\\Magento\\VaultGraphQl\\Model\\Resolver\\DeletePaymentToken") @doc(description:"Delete a customer's payment token.")
 }
 
 type DeletePaymentTokenOutput @doc(description: "Indicates whether the request succeeded and returns the remaining customer payment tokens.") {
     result: Boolean! @doc(description: "Indicates whether the request succeeded.")
-    customerPaymentTokens: CustomerPaymentTokens @resolver(class: "\\Magento\\VaultGraphQl\\Model\\Resolver\\PaymentTokens") @doc(description: "An array of the customer's remaining payment tokens.")
+    customerPaymentTokens: CustomerPaymentTokens @resolver(class: "\\Magento\\VaultGraphQl\\Model\\Resolver\\PaymentTokens") @doc(description: "A container for the customer's remaining payment tokens.")
 }
 
 type Query {
     customerPaymentTokens: CustomerPaymentTokens @doc(description: "Return a list of customer payment tokens stored in the vault.") @resolver(class: "\\Magento\\VaultGraphQl\\Model\\Resolver\\PaymentTokens") @cache(cacheable: false)
 }
 
-type CustomerPaymentTokens @resolver(class: "\\Magento\\VaultGraphQl\\Model\\Resolver\\PaymentTokens") @doc(description: "Contains an array of the payment token stored in the customer's vault.") {
+type CustomerPaymentTokens @resolver(class: "\\Magento\\VaultGraphQl\\Model\\Resolver\\PaymentTokens") @doc(description: "Contains payment tokens stored in the customer's vault.") {
     items: [PaymentToken]! @doc(description: "An array of payment tokens.")
 }