Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Updating search and pagination topic #3840

Merged
merged 8 commits into from
Mar 5, 2019
Merged

Conversation

keharper
Copy link
Contributor

@keharper keharper commented Feb 28, 2019

This PR is a:

  • New topic
  • Content update
  • Content fix or rewrite
  • Bug fix or improvement

Summary

GraphQL PR magento/graphql-ce#259 added the ability to use variables in queries. This PR not only adds information about variables, but also restructures the document so that the "Searches and Pagination" topic talks about queries in general. When the topic was written, there was only one type of query: the product search query.

I've renamed the topic to "Queries" and updated all of the links to it.

Related devdocs issue: #3716

Additional information

List all affected URLs
https://devdocs.magento.com/guides/v2.3/graphql/search-pagination.html

to be renamed to

https://devdocs.magento.com/guides/v2.3/graphql/queries.html

whatsnew
The "Searches and Pagination" topic has been expanded to include more information about queries and renamed to "Queries".

@keharper keharper self-assigned this Feb 28, 2019
@keharper keharper added Major Update Significant original updates to existing content Internal Dev Differentiates work between community and Magento staff Community Docs impacted by community code contribution xx2.3.1 Magento 2.3.1 changes labels Feb 28, 2019
@keharper keharper requested a review from erikmarr February 28, 2019 18:21
Copy link
Contributor

@erikmarr erikmarr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor edits

@keharper keharper requested a review from paliarush March 1, 2019 16:40
@shrielenee shrielenee added the Waiting for Response Waiting for response from internal/external parties label Mar 5, 2019
---

A GraphQL search query can contain the following components:
A GraphQL query retrieves data from the Magento server in a similar manner as a REST GET call. However, Magento GraphQL queries are not meant to be as comprehensive as their REST counterparts. The main purpose of the Magento GraphQL queries is to allow a mobile app or browser to render a wide variety of information, including the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are not meant to be as comprehensive as their REST this seems to be inaccurate. GraphQL must cover all storefront scenarios covered with REST and make it possible to query more data in one request.
Long-term the main difference is that GraphQL will support store-front use cases while REST will support admin use cases.

@keharper keharper removed the Waiting for Response Waiting for response from internal/external parties label Mar 5, 2019
@keharper keharper merged commit 62ed99a into 2.3.1-integration Mar 5, 2019
@ghost
Copy link

ghost commented Mar 5, 2019

Hi @keharper, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Community Docs impacted by community code contribution Internal Dev Differentiates work between community and Magento staff Major Update Significant original updates to existing content xx2.3.1 Magento 2.3.1 changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants