Merge remote-tracking branch 'origin/DOC-475-misc-ce' into graphql-doc-changes

Author: cpartica

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

@@ -2,20 +2,20 @@
 # See COPYING.txt for license details.
 
 type Query {
-    checkoutAgreements: [CheckoutAgreement] @resolver(class: "Magento\\CheckoutAgreementsGraphQl\\Model\\Resolver\\CheckoutAgreements") @doc(description: "The Checkout Agreements information")
+    checkoutAgreements: [CheckoutAgreement] @resolver(class: "Magento\\CheckoutAgreementsGraphQl\\Model\\Resolver\\CheckoutAgreements") @doc(description: "Return Terms and Conditions configuration information.")
 }
 
-type CheckoutAgreement @doc(description: "Defines all Checkout Agreement information") {
-    agreement_id: Int! @doc(description: "Checkout Agreement identifier")
-    name: String! @doc(description: "Checkout Agreement name")
-    content: String! @doc(description: "Checkout Agreement content")
-    content_height: String @doc(description: "Checkout Agreement content height")
-    checkbox_text: String! @doc(description: "Checkout Agreement checkbox text")
-    is_html: Boolean! @doc(description: "Is Checkout Agreement content in HTML format")
-    mode: CheckoutAgreementMode!
+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: "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.")
+    mode: CheckoutAgreementMode! @doc(description: "Indicates whether agreements are accepted automatically or manually.")
 }
 
-enum CheckoutAgreementMode {
-    AUTO
-    MANUAL
+enum CheckoutAgreementMode @doc(description: "Indicates how agreements are accepted.") {
+    AUTO @doc(description: "Conditions are automatically accepted upon checkout.")
+    MANUAL @doc(description: "Shoppers must manually accept the conditions to place an order.")
 }

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

@@ -1,43 +1,43 @@
 # Copyright © Magento, Inc. All rights reserved.
 # See COPYING.txt for license details.
-type StoreConfig @doc(description: "The type contains information about a store config") {
-    front : String @doc(description: "Default Web URL")
-    cms_home_page : String @doc(description: "CMS Home Page")
-    no_route : String @doc(description: "Default No-route URL")
-    cms_no_route : String @doc(description: "CMS No Route Page")
-    cms_no_cookies : String @doc(description: "CMS No Cookies Page")
-    show_cms_breadcrumbs : Int @doc(description: "Show Breadcrumbs for CMS Pages")
+type StoreConfig {
+    front : String @doc(description: "The landing page that is associated with the base URL.")
+    cms_home_page : String @doc(description: "The name of the CMS page that identifies the home page for the store.")
+    no_route : String @doc(description: "The default page that displays when a 404 'Page not Found' error occurs.")
+    cms_no_route : String @doc(description: "A specific CMS page that displays when a 404 'Page Not Found' error occurs.")
+    cms_no_cookies : String @doc(description: "A specific CMS page that displays when cookies are not enabled for the browser.")
+    show_cms_breadcrumbs : Int @doc(description: "Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes).")
 }
 
 
 type Query {
     cmsPage (
-        id: Int @doc(description: "Id of the CMS page") @deprecated(reason: "The `id` is deprecated. Use `identifier` instead.") @doc(description: "The CMS page query returns information about a CMS page")
-        identifier: String @doc(description: "Identifier of the CMS page")
-    ): CmsPage @resolver(class: "Magento\\CmsGraphQl\\Model\\Resolver\\Page") @doc(description: "The CMS page query returns information about a CMS page") @cache(cacheIdentity: "Magento\\CmsGraphQl\\Model\\Resolver\\Page\\Identity")
+        id: Int @doc(description: "The ID of the CMS page.") @deprecated(reason: "Use `identifier` instead.")
+        identifier: String @doc(description: "The identifier of the CMS page.")
+    ): CmsPage @resolver(class: "Magento\\CmsGraphQl\\Model\\Resolver\\Page") @doc(description: "Return details about a CMS page.") @cache(cacheIdentity: "Magento\\CmsGraphQl\\Model\\Resolver\\Page\\Identity")
     cmsBlocks (
-        identifiers: [String] @doc(description: "Identifiers of the CMS blocks")
-    ): CmsBlocks @resolver(class: "Magento\\CmsGraphQl\\Model\\Resolver\\Blocks") @doc(description: "The CMS block query returns information about CMS blocks") @cache(cacheIdentity: "Magento\\CmsGraphQl\\Model\\Resolver\\Block\\Identity")
+        identifiers: [String] @doc(description: "An array of CMS block IDs.")
+    ): CmsBlocks @resolver(class: "Magento\\CmsGraphQl\\Model\\Resolver\\Blocks") @doc(description: "Return information about CMS blocks.") @cache(cacheIdentity: "Magento\\CmsGraphQl\\Model\\Resolver\\Block\\Identity")
 }
 
-type CmsPage implements RoutableInterface @doc(description: "CMS page defines all CMS page information") {
-    identifier: String @doc(description: "Identifier of the CMS page")
-    url_key: String @doc(description: "URL key of CMS page")
-    title: String @doc(description: "CMS page title")
-    content: String @doc(description: "CMS page content")
-    content_heading: String @doc(description: "CMS page content heading")
-    page_layout: String @doc(description: "CMS page content heading")
-    meta_title: String @doc(description: "CMS page meta title")
-    meta_description: String @doc(description: "CMS page meta description")
-    meta_keywords: String @doc(description: "CMS page meta keywords")
+type CmsPage implements RoutableInterface @doc(description: "Contains details about a CMS page.") {
+    identifier: String @doc(description: "The ID of a CMS page.")
+    url_key: String @doc(description: "The URL key of the CMS page, which is often based on the `content_heading`.")
+    title: String @doc(description: "The name that appears in the breadcrumb trail navigation and in the browser title bar and tab.")
+    content: String @doc(description: "The content of the CMS page in raw HTML.")
+    content_heading: String @doc(description: "The heading that displays at the top of the CMS page.")
+    page_layout: String @doc(description: "The design layout of the page, indicating the number of columns and navigation features used on the page.")
+    meta_title: String @doc(description: "A page title that is indexed by search engines and appears in search results listings.")
+    meta_description: String @doc(description: "A brief description of the page for search results listings.")
+    meta_keywords: String @doc(description: "A brief description of the page for search results listings.")
 }
 
-type CmsBlocks @doc(description: "CMS blocks information") {
-    items: [CmsBlock] @doc(description: "An array of CMS blocks")
+type CmsBlocks @doc(description: "Contains an array CMS block items.") {
+    items: [CmsBlock] @doc(description: "An array of CMS blocks.")
 }
 
-type CmsBlock @doc(description: "CMS block defines all CMS block information") {
-    identifier: String @doc(description: "CMS block identifier")
-    title: String @doc(description: "CMS block title")
-    content: String @doc(description: "CMS block content")
+type CmsBlock @doc(description: "Contains details about a specific CMS block.") {
+    identifier: String @doc(description: "The CMS block identifier.")
+    title: String @doc(description: "The title assigned to the CMS block.")
+    content: String @doc(description: "The content of the CMS block in raw HTML.")
 }

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

@@ -2,38 +2,38 @@
 # See COPYING.txt for license details.
 
 type Query {
-    currency: Currency @resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Currency") @doc(description: "The currency query returns information about store currency.") @cache(cacheable: false)
+    currency: Currency @resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Currency") @doc(description: "Return information about the store's currency.") @cache(cacheable: false)
     countries: [Country] @resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Countries") @doc(description: "The countries query provides information for all countries.") @cache(cacheable: false)
     country (id: String): Country @resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Country") @doc(description: "The countries query provides information for a single country.") @cache(cacheable: false)
 }
 
 type Currency {
-    base_currency_code: String
-    base_currency_symbol: String
+    base_currency_code: String @doc(description: "The base currency set for the store, such as USD.")
+    base_currency_symbol: String @doc(description: "The symbol for the specified base currency, such as $.")
     default_display_currecy_code: String @deprecated(reason: "Symbol was missed. Use `default_display_currency_code`.")
-    default_display_currency_code: String
-    default_display_currecy_symbol: String @deprecated(reason: "Symbol was missed. Use `default_display_currency_symbol`.")
-    default_display_currency_symbol: String
-    available_currency_codes: [String]
-    exchange_rates: [ExchangeRate]
+    default_display_currency_code: String @doc(description: "The currency that is displayed by default, such as USD.")
+    default_display_currecy_symbol: String @deprecated(reason: "Symbol was missed. Use `default_display_currency_code`.")
+    default_display_currency_symbol: String @doc(description: "The currency symbol that is displayed by default, such as $.")
+    available_currency_codes: [String] @doc(description: "An array of three-letter currency codes accepted by the store, such as USD and EUR.")
+    exchange_rates: [ExchangeRate] @doc(description: "An array of exchange rates for currencies defined in the store.")
 }
 
-type ExchangeRate {
-    currency_to: String
-    rate: Float
+type ExchangeRate @doc(description: "Lists the exchange rate.") {
+    currency_to: String @doc(description: "Specifies the store’s default currency to exchange to.")
+    rate: Float @doc(description: "The exchange rate for the store’s default currency.")
 }
 
 type Country {
     id: String @doc(description: "The unique ID for a `Country` object.")
-    two_letter_abbreviation: String
-    three_letter_abbreviation: String
-    full_name_locale: String
-    full_name_english: String
-    available_regions: [Region]
+    two_letter_abbreviation: String @doc(description: "The two-letter abbreviation of the country, such as US.")
+    three_letter_abbreviation: String @doc(description: "The three-letter abbreviation of the country, such as USA.")
+    full_name_locale: String @doc(description: "The name of the country in the current locale.")
+    full_name_english: String @doc(description: "The name of the country in English.")
+    available_regions: [Region] @doc(description: "An array of regions within a particular country.")
 }
 
 type Region {
     id: Int @doc(description: "The unique ID for a `Region` object.")
-    code: String
-    name: String
+    code: String @doc(description: "The two-letter code for the region, such as TX for Texas.")
+    name: String @doc(description: "The name of the region, such as Texas.")
 }

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

@@ -2,42 +2,42 @@
 # See COPYING.txt for license details.
 
 type Query {
-    customAttributeMetadata(attributes: [AttributeInput!]!): CustomAttributeMetadata @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\CustomAttributeMetadata") @doc(description: "The customAttributeMetadata query returns the attribute type, given an attribute code and entity type") @cache(cacheable: false)
+    customAttributeMetadata(attributes: [AttributeInput!]! @doc(description: "An input object that specifies the attribute code and entity type to search.")): CustomAttributeMetadata @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\CustomAttributeMetadata") @doc(description: "Return the attribute type, given an attribute code and entity type.") @cache(cacheable: false)
 }
 
-type CustomAttributeMetadata @doc(description: "CustomAttributeMetadata defines an array of attribute_codes and entity_types") {
-    items: [Attribute] @doc(description: "An array of attributes")
+type CustomAttributeMetadata @doc(description: "Defines an array of custom attributes.") {
+    items: [Attribute] @doc(description: "An array of attributes.")
 }
 
-type Attribute @doc(description: "Attribute contains the attribute_type of the specified attribute_code and entity_type") {
+type Attribute @doc(description: "Contains details about the attribute, including the code and type.") {
     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")
-    attribute_type: String @doc(description: "The data type of the attribute")
-    input_type: String @doc(description: "The frontend input type of the attribute")
+    entity_type: String @doc(description: "The type of entity that defines the attribute.")
+    attribute_type: String @doc(description: "The data type of the attribute.")
+    input_type: String @doc(description: "The frontend input type of the attribute.")
     attribute_options: [AttributeOption] @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\AttributeOptions") @doc(description: "Attribute options list.")
-    storefront_properties: StorefrontProperties @doc(description: "Contains details about the storefront properties configured for the attribute")
+    storefront_properties: StorefrontProperties @doc(description: "Details about the storefront properties configured for the attribute.")
 }
 
-type StorefrontProperties {
-    use_in_product_listing: Boolean @doc(description: "Indicates whether the attribute is displayed in product listings")
-    position: Int @doc(description: "The relative position of the attribute in the layered navigation block")
-    visible_on_catalog_pages: Boolean @doc(description: "Indicates whether the attribute is displayed on product pages")
-    use_in_layered_navigation: UseInLayeredNavigationOptions @doc(description: "Indicates whether the attribute is filterable with results, without results, or not at all")
-    use_in_search_results_layered_navigation: Boolean @doc(description: "Indicates whether the attribute can be used in layered navigation on search results pages")
+type StorefrontProperties @doc(description: "Indicates where an attribute can be displayed.") {
+    use_in_product_listing: Boolean @doc(description: "Indicates whether the attribute is displayed in product listings.")
+    position: Int @doc(description: "The relative position of the attribute in the layered navigation block.")
+    visible_on_catalog_pages: Boolean @doc(description: "Indicates whether the attribute is displayed on product pages.")
+    use_in_layered_navigation: UseInLayeredNavigationOptions @doc(description: "Indicates whether the attribute is filterable with results, without results, or not at all.")
+    use_in_search_results_layered_navigation: Boolean @doc(description: "Indicates whether the attribute can be used in layered navigation on search results pages.")
 }
 
-enum UseInLayeredNavigationOptions {
+enum UseInLayeredNavigationOptions @doc(description: "Defines whether the attribute is filterable in layered navigation.") {
     NO
     FILTERABLE_WITH_RESULTS
     FILTERABLE_NO_RESULT
 }
 
-type AttributeOption @doc(description: "Attribute option.") {
-    label: String @doc(description: "Attribute option label.")
-    value: String @doc(description: "Attribute option value.")
+type AttributeOption @doc(description: "Defines an attribute option.") {
+    label: String @doc(description: "The label assigned to the attribute option.")
+    value: String @doc(description: "The attribute option value.")
 }
 
-input AttributeInput @doc(description: "AttributeInput 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")
+    entity_type: String @doc(description: "The type of entity that defines the attribute.")
 }