Merge pull request magento#2023 from magento/kh_graphql-pr-7-12

keharper · web-flow · commit 3c0ce60c13ff · 2018-05-23T11:06:05.000-05:00
Updates for GraphQL PR magento#7 and magento#12
diff --git a/guides/v2.3/graphql/reference/products.md b/guides/v2.3/graphql/reference/products.md
@@ -105,6 +105,7 @@ items: [ProductInterface]
 page_info: SearchResultPageInfo
 total_count: Int
 filters: [LayerFilter]
+sort_fields: SortFields
 {% endhighlight %}
 
 Each attribute is described below:
@@ -115,6 +116,7 @@ Attribute |  Description
 `page_info` | An object that includes the `page_info` and `currentPage` values specified in the query
 `total_count` | The number of products returned
 `filters` | An array of layered navigation filters. These filters can be used to implement layered navigation on your app.
+`sort_fields` | An object that includes the default sort field and all available sort fields
 
 
 When a product requires a filter attribute that is not a field on its output schema, inject the attribute name into the class in a module's `di.xml` file.
@@ -129,7 +131,7 @@ When a product requires a filter attribute that is not a field on its output sch
   </arguments>
 </type>
 ```
-This example adds `field_to_sort` and `other_field_to_sort` attributes to the `additionalAttributes` array, which is defined in the `ProductEntityAttributesForAst` class. The array automatically contains the `min_price`, `max_price`, and `category_ids`attributes. 
+This example adds `field_to_sort` and `other_field_to_sort` attributes to the `additionalAttributes` array defined in the `ProductEntityAttributesForAst` class. The array also contains the `min_price`, `max_price`, and `category_ids`attributes.
 
 
 ## ProductInterface {#ProductInterface}
@@ -150,6 +152,7 @@ The following table defines the `ProductInterface` attributes and objects.
 Attribute | Data type | Description
 --- | --- | ---
 `attribute_set_id` | Int | The attribute set assigned to the product
+`canonical_url` | String  | The canonical URL for the product
 `categories` | [CategoryInterface] | The categories assigned to the product. See [categories endpoint]({{ page.baseurl }}/graphql/reference/categories.html) for more information
 `category_ids` | [Int] | An array of category IDs the product belongs to
 `country_of_manufacture` | String | The product's country of origin
@@ -323,6 +326,22 @@ Field | Type | Description
 `value_string` | String | The value for filter request variable to be used in a query
 `items_count` | Int | The number of items the filter returned
 
+## SortFields object
+
+The `SortFields` object contains the default value for sort fields as well as all possible sort fields.
+
+Field | Type | Description
+--- | --- | ---
+`default` | String | The default sort field
+`options` | `SortField` | An array that contains all the fields you can use for sorting
+
+### SortField object
+
+Field | Type | Description
+--- | --- | ---
+`value` | String | The attribute name or code to use as the sort field
+`label` | String | The attribute's label
+
 ## Sample query
 
 You can review several general interest `products` queries at [Searches and pagination in GraphQL]({{ page.baseurl }}/graphql/search-pagination.html).
