Using the /search endpoint #5929

pmarjan · 2019-11-05T16:27:32Z

Using the /search endpoint

whatsnew
Added the Search for products with the /search endpoint topic.

devops-devdocs · 2019-11-05T16:29:03Z

An admin must run tests on this PR before it can be merged.

magento-engcom-team · 2019-11-05T16:34:49Z

@pmarjan thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

dobooth · 2019-11-05T17:43:23Z

Hi @pmarjan Thanks for your contribution! The red 'x's above note a couple issues: First, please sign the new Adobe CLA so we can get this merged. Second, you have some markdown errors. Click the Details link above to see them. When using unordered lists, there should be two spaces between the * and the text. This is so it aligns the same way as ordered lists. And if each version is identical, consider symlinking them. For API call examples, please use ```http.

keharper

I've committed some changes for grammar, style, and linting. Please pull them in to your local branch and address the remaining comments. I'll have some follow-up questions, but we need to take care of the basics first.

If you're with a partner that isn't showing up in the list yet, add the company name and URL to the contributor_name/_link lines. Otherwise, include your name and a link to your GitHub account or professional website.

On the surface, the v2.2 and v2.3 versions of the file look the same. If they are, delete the v2.3 version and replace it with a symlink to the v2.2 version. If they're different, apply the changes I made to the v2.2 to the v2.3 version as much as possible.

keharper · 2019-11-06T03:42:33Z

_data/toc/rest-api.yml

@@ -54,6 +54,9 @@ pages:
        - label: Search using REST
          url: /rest/performing-searches.html

+        - label: Search using /search endpoint


Suggested change

- label: Search using /search endpoint

- label: Search with the /search endpoint

guides/v2.2/rest/search-endpoint.md

keharper · 2019-11-06T04:13:51Z

guides/v2.2/rest/search-endpoint.md

+```
+GET {{URL}}rest/V1/search?searchCriteria[requestName]=quick_search_container&
+searchCriteria[filter_groups][0][filters][0][field]=search_term&
+searchCriteria[filter_groups][0][filters][0][value]=Shirt


Shirt doesn't look correct here.

guides/v2.2/rest/search-endpoint.md

nuzil · 2019-11-06T10:19:54Z

guides/v2.2/rest/search-endpoint.md

+---
+
+By using `GET {{URL}}rest/V1/search`, you can search through the catalog. The obtained results will come from your configured search engine (**Stores** > Settings > **Configuration** > **Catalog** > **Catalog Search** > **Search engine**).
+This means you can collect results from Elasticsearch, for example, that are very similar to the results that are visible by using the regular frontend search.


I would not be strict here to which engine is used even as example, maybe better to write
"This means you can collect results from search engine that is enabled. And those results will be equal to the results that are coming by using the regular frontend search."

ghost · 2019-11-06T10:24:20Z

Hi @pmarjan, 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.

nuzil · 2019-11-06T10:25:04Z

Sorry, I closed and re-open PR cause I added Marjan to comwrap team and wanted that system recognised that

pmarjan · 2019-11-08T10:08:27Z

@keharper , @nuzil
the requested changes are done.
Please let me know if anything extra is needed.

keharper · 2019-11-08T22:12:15Z

I don't know how to push filesystem changes, so I have to just give instructions on setting up a symlink from 2.2 to 2.3.

cd <devdocs_root>/guides/v2.3/rest/
rm search-endpoint.md
ln -s ../../v2.2/rest/search-endpoint.md .

I've been testing your examples and have some further comments. I'll try to add them by Monday.

keharper · 2019-11-08T22:15:07Z

Also, this PR should probably be rebased to master. I don't think anything discussed here is new technology--just undocumented. If so, this topic should be made available immediately, instead of waiting till the 2.3.4 release date.

nuzil

Looks good for me. Lets wait for some comments from @keharper

pmarjan · 2019-11-11T15:29:24Z

@keharper
the symlink is updated and commits are rabased to master.

keharper · 2019-11-11T20:16:24Z

This topic needs some information about when you'd use GET V1/search vs GET V1/products. Some differences I see between the two:

search can be run on behalf of a guest user. products requires an admin token
The syntaxes are similar but different. search requires one of 3 requestNames. I'm not sure if products is more flexible on the attributes it can search by default.
search can return aggregation/bucket data

Provide descriptions of the 3 search types. quick and advanced is self-explanatory, but I have no idea what catalog_view really means.

keharper · 2019-11-11T20:36:13Z

guides/v2.2/rest/search-endpoint.md

+The basic usage is:
+
+```http
+GET <host>/rest/<store_code>/V1/search?searchCriteria[requestName]=quick_search_container&


I tried this query, except I used name as the search term. The name attribute is set to Use in Search is set to Yes. Based on the statement in line 8, I would expect the search to work. catalog_view_container doesn't work either, but advanced_search_container does.

I think it is like this:
The field can be set to be search_term only in the quick_search_container. This means both catalog_view and advanced will not work in that case.
Please send the queries you use? I could check them.

pmarjan · 2019-11-13T17:00:09Z

I have now made new version where there is an attempt to outline some differences between the search types, but also between using the v1/search and v1/products. At the end small summary is added too.

keharper · 2019-11-13T19:11:33Z

@pmarjan These are some nice additions. I'm going to move things around a bit, but hopefully we can get this to its final state by tomorrow.

pmarjan · 2019-11-15T13:45:56Z

@keharper
I saw your last additions. Much nicer to read now :)
But, is there anything else that I could/should do?

keharper · 2019-11-15T15:30:00Z

@pmarjan I forgot to tag you and ask for you to review my changes. Since you've done that, you're done. Thanks!

dobooth · 2019-11-18T17:54:51Z

running tests

dobooth · 2019-11-18T18:05:11Z

running tests

dobooth · 2019-11-19T15:48:07Z

running tests

ghost · 2019-11-19T16:04:07Z

Hi @pmarjan, 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.

nuzil self-requested a review November 5, 2019 16:28

nuzil self-assigned this Nov 5, 2019

m2-community-project bot added the Progress: review label Nov 5, 2019

keharper self-assigned this Nov 6, 2019

keharper suggested changes Nov 6, 2019

View reviewed changes

keharper added 2.2.x 2.3.x Magento 2.3 related changes New Topic A major update published as an entirely new document labels Nov 6, 2019

nuzil suggested changes Nov 6, 2019

View reviewed changes

nuzil added Partner: Comwrap partners-contribution PR created by Magento partner labels Nov 6, 2019

nuzil closed this Nov 6, 2019

nuzil reopened this Nov 6, 2019

m2-community-project bot added Progress: changes requested and removed Progress: review labels Nov 6, 2019

nuzil approved these changes Nov 11, 2019

View reviewed changes

pmarjan and others added 6 commits November 11, 2019 16:18

Using the /search endpoint

f383358

Update rest-api.yml

69d1811

Update search-endpoint.md

2818d68

Update search-endpoint.md

0fe8782

Updates as per request points

6948b91

Symlink for v2.3

f5731fc

pmarjan force-pushed the endpoint-search branch from 57c478b to 262cc47 Compare November 11, 2019 15:25

keharper changed the base branch from develop to master November 11, 2019 18:45

m2-community-project bot added Progress: approved and removed Progress: changes requested labels Nov 11, 2019

Update search-endpoint.md

c4221da

keharper reviewed Nov 11, 2019

View reviewed changes

keharper added the Waiting for Response Waiting for response from internal/external parties label Nov 13, 2019

Outline differences between search types and v1/search and v1/products

9255476

Update search-endpoint.md

238fdc3

keharper removed the Waiting for Response Waiting for response from internal/external parties label Nov 15, 2019

keharper approved these changes Nov 18, 2019

View reviewed changes

Merge branch 'master' into endpoint-search

bd13be7

Trailing space

544c27c

keharper requested a review from dobooth November 18, 2019 18:08

Fixed up links.

37cf456

dobooth approved these changes Nov 18, 2019

View reviewed changes

m2-community-project bot assigned dobooth Nov 18, 2019

Merge branch 'master' into endpoint-search

5bd7264

dobooth merged commit 4a94960 into magento:master Nov 19, 2019

m2-community-project bot removed the Progress: approved label Nov 19, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using the /search endpoint #5929

Using the /search endpoint #5929

pmarjan commented Nov 5, 2019 •

edited by dobooth

Loading

devops-devdocs commented Nov 5, 2019

magento-engcom-team commented Nov 5, 2019

dobooth commented Nov 5, 2019 •

edited

Loading

keharper left a comment

keharper Nov 6, 2019

keharper Nov 6, 2019

nuzil Nov 6, 2019

ghost commented Nov 6, 2019

nuzil commented Nov 6, 2019

pmarjan commented Nov 8, 2019

keharper commented Nov 8, 2019

keharper commented Nov 8, 2019

nuzil left a comment

pmarjan commented Nov 11, 2019

keharper commented Nov 11, 2019

keharper Nov 11, 2019

pmarjan Nov 13, 2019

pmarjan commented Nov 13, 2019

keharper commented Nov 13, 2019

pmarjan commented Nov 15, 2019

keharper commented Nov 15, 2019

dobooth commented Nov 18, 2019

dobooth commented Nov 18, 2019

dobooth commented Nov 19, 2019

ghost commented Nov 19, 2019

	- label: Search using /search endpoint
	- label: Search with the /search endpoint

Using the /search endpoint #5929

Using the /search endpoint #5929

Conversation

pmarjan commented Nov 5, 2019 • edited by dobooth Loading

devops-devdocs commented Nov 5, 2019

magento-engcom-team commented Nov 5, 2019

dobooth commented Nov 5, 2019 • edited Loading

keharper left a comment

Choose a reason for hiding this comment

keharper Nov 6, 2019

Choose a reason for hiding this comment

keharper Nov 6, 2019

Choose a reason for hiding this comment

nuzil Nov 6, 2019

Choose a reason for hiding this comment

ghost commented Nov 6, 2019

nuzil commented Nov 6, 2019

pmarjan commented Nov 8, 2019

keharper commented Nov 8, 2019

keharper commented Nov 8, 2019

nuzil left a comment

Choose a reason for hiding this comment

pmarjan commented Nov 11, 2019

keharper commented Nov 11, 2019

keharper Nov 11, 2019

Choose a reason for hiding this comment

pmarjan Nov 13, 2019

Choose a reason for hiding this comment

pmarjan commented Nov 13, 2019

keharper commented Nov 13, 2019

pmarjan commented Nov 15, 2019

keharper commented Nov 15, 2019

dobooth commented Nov 18, 2019

dobooth commented Nov 18, 2019

dobooth commented Nov 19, 2019

ghost commented Nov 19, 2019

pmarjan commented Nov 5, 2019 •

edited by dobooth

Loading

dobooth commented Nov 5, 2019 •

edited

Loading