Add breadcrumb info to GraphQL categories topic #2767
Conversation
keharper
added
Major Update
guides/v2.3/graphql/index.md
Outdated
|
|
||
|
|
||
| {:.bs-callout .bs-callout-info} | ||
| You can access the GraphQL introspection feature only if your Magento instance is in developer mode. See [Set the Magento mode]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-mode.html) for more information about modes. |
There was a problem hiding this comment.
Consider leaving off "for more information about modes" -- just
"See [Set the Magento mode]."
There was a problem hiding this comment.
That's too terse for me. Changed to
[Set the Magento mode] describes how to check and change the mode.
| @@ -40,17 +40,19 @@ Attribute | Data type | Description | |||
| `product_count`| Int | The number of products in the category | |||
| `default_sort_by`| String | The attribute to use for sorting | |||
| `products(<attributes>)` | `CategoryProducts` | The list of products assigned to the category | |||
| `children` | `CategoryTree` | | |||
| `breadcrumbs` | `Breadcrumb` | | |||
There was a problem hiding this comment.
Breadcrumb description missing because it's obvious, right?
Further down page: Breadcrumb object --- Make Breadcrumb link to the Breadcrumb object
or in description: A Breadcrumb object that contains a set of links to show customers where they are in relation to other ....
| `sort` | `ProductSortInput` Specifies which attribute to sort on, and whether to return the results in ascending or descending order. See [Searches and pagination in GraphQL]({{ page.baseurl }}/graphql/search-pagination.html) for more information. | ||
|
|
||
| #### CategoryProducts | ||
| `sort` | `ProductSortInput` | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. See [Searches and pagination in GraphQL]({{ page.baseurl }}/graphql/search-pagination.html) for more information. |
There was a problem hiding this comment.
Consider dropping "for more information"
There was a problem hiding this comment.
Changed to [Searches and pagination in GraphQL] describes sort orders.
| @@ -4,11 +4,11 @@ title: category endpoint | |||
| version: 2.3 | |||
| --- | |||
|
|
|||
| The `category` endpoint allows you to search for a single category definition or the entire category tree. | |||
| The `category` endpoint allows you to search for a single category definition or the entire category tree. To return multiple category levels in a single call, define the response so that it contains up to ten nested `children` options. You cannot return the entire category tree if it contains more than 10 sublevels. | |||
|
|
|||
There was a problem hiding this comment.
Not sure if it helps, but consider adding a "for example"
define a response so that it contains up to ten nested children options, for example the query can return a CategoryTree object with up to ten levels of categories, and each of those categories can contain up to ten CategoryTree objects with up to ten subcategories.
Also, in the Sample Queries section -- It might be good to show a real response for the CategoryTree query since it's kind of complicated.
There was a problem hiding this comment.
I left the description as is, but added sample output.
| @@ -39,7 +39,7 @@ Attribute | Data type | Description | |||
| `product_count`| Int | The number of products in the category | |||
| `default_sort_by`| String | The attribute to use for sorting | |||
| `products(<attributes>)` | `CategoryProducts` | The list of products assigned to the category | |||
| `breadcrumbs` | `Breadcrumb` | | |||
| `breadcrumbs` | `Breadcrumb` | A `Breadcrumb` object contains information about each category that | |||
There was a problem hiding this comment.
Missing the end of the Breadcrumb description.....
| @@ -51,7 +51,7 @@ Attribute | Data type | Description | |||
| --- | --- | --- | |||
| `pageSize` | Int | Specifies the maximum number of results to return at once. This attribute is optional. The default value is 20. | |||
| `currentPage` | Int | Specifies which page of results to return. The default value is 1. | |||
| `sort` | `ProductSortInput` | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. See [Searches and pagination in GraphQL]({{ page.baseurl }}/graphql/search-pagination.html) for more information. | |||
| `sort` | `ProductSortInput` | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. [Searches and pagination in GraphQL]({{ page.baseurl }}/graphql/search-pagination.html) describes sort orders. | |||
|
|
|||
There was a problem hiding this comment.
I like the way you changed the "See" reference 🥇
| @@ -3,11 +3,11 @@ group: graphql | |||
| title: category endpoint | |||
| --- | |||
|
|
|||
| The `category` endpoint allows you to search for a single category definition or the entire category tree. | |||
| The `category` endpoint allows you to search for a single category definition or the entire category tree. To return multiple category levels in a single call, define the response so that it contains up to ten nested `children` options. You cannot return the entire category tree if it contains more than 10 sublevels. | |||
There was a problem hiding this comment.
Just a note, nesting level limit can be re-configured via di.xml by the system integrator.
Add support for OpenSearch for on-premises installation
This PR is a:
Summary
When this pull request is merged, it will document the breadcrumb support added in GraphQL PR-112
whatsnew
Added information about breadcrumbs in the GraphQL category topic.