[BUG] PPL example on website not working

[jonkerw85]

Describe the bug
The example on https://opensearch.org/docs/search-plugins/ppl/index/ is not working.

To Reproduce

1. Go to the website https://opensearch.org/docs/search-plugins/ppl/index/
2. Copy and paste the code in de Quick Start section to create the accounts index on your cluster
3. In your cluster go to de Query Workbench, select PPL in de right corner
4. Execute the PPL query that is suggested on https://opensearch.org/docs/search-plugins/ppl/index/

Expected behavior
Query result.

Plugins
Opensearch distro 7.10

Screenshots

Host/Environment (please complete the following information):

• OS: AWS Elasticsearch
• Version 7.10

[CEHENKLE]

Transferring to the SQL team. If I've move this in error, please @ me and I'll move it back :)

[chloe-zh]

Hi @wjonkerhulst , I tried the same steps in the documentation, but was not able to reproduce it. Could you try to execute in dev tools by using the following command to see what the error is returned?

POST _opendistro/_sql
{
  "query":"search source=accounts | where age > 18 | fields firstname, lastname"
}

[jonkerw85]

@chloe-zh

[chloe-zh]

My bad, the endpoint should be _opendistro/_ppl

[jonkerw85]

@chloe-zh No problem. The PPL endpoint works.

[jonkerw85]

@chloe-zh I think I have found the problem.

A single line query works:

But when I copy and paste the example it is multi-line and the query stops working.

[elfisher]

I can confirm this is still an issue in 1.1. I cannot get multi-line to work in the query workbench, so that might be the issue. @chloe-zh do you know if that is a known issue?

[camAtGitHub]

Hello @chloe-zh the issue is that 'Query Workbench' is not escaping quotes etc.
Attempting to run search source=accounts | where gender="F" results in: Events: no response, this query is not runnable.
However running search source=accounts | where gender=\"F\" returns the expected data.
The frustrating part is that documentation is either incorrect or an escaping bug has been introduced.

Thanks
(I'm running OS 1.1.0 docker build BTW)

[joshuali925]

Hi, looks like there are two issues:

1. line breaks were not handled correctly for PPL in workbench, causing multiline query to fail
2. quotes are not properly escaped

Both will be fixed in #305, thanks for reporting them!