honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Update SQL REST API pages for new structure (#50690) 

#43007 restructured the SQL REST API docs so they display across several pages.

This updates up a reference that assumes a single page in the "Paginating through a large response" section. It also reformats a tip for the Kibana console.

Closes #50688
This commit is contained in:
James Rodewig 2020-01-07 09:17:54 -06:00
parent 060e0a6277
commit 0753915eed
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/sql/endpoints/rest.asciidoc
View File

@ -42,12 +42,15 @@ James S.A. Corey |Leviathan Wakes |561 |2011-06-02T00:00:00.000Z
// TESTRESPONSE[non_json] // TESTRESPONSE[non_json]
[[sql-kibana-console]] [[sql-kibana-console]]
[TIP]
.Using Kibana Console .Using Kibana Console
====
If you are using {kibana-ref}/console-kibana.html[Kibana Console] If you are using {kibana-ref}/console-kibana.html[Kibana Console]
(which is highly recommended), take advantage of the (which is highly recommended), take advantage of the
triple quotes `"""` when creating the query. This not only automatically escapes double triple quotes `"""` when creating the query. This not only automatically escapes double
quotes (`"`) inside the query string but also support multi-line as shown below: quotes (`"`) inside the query string but also support multi-line as shown below:
image:images/sql/rest/console-triple-quotes.png[] image:images/sql/rest/console-triple-quotes.png[]
====
[[sql-rest-format]] [[sql-rest-format]]
=== Response Data Formats === Response Data Formats
@ -270,8 +273,9 @@ cursor: "sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWWWdrRlVfSS1TbDYtcW9lc1FJNmlYdw==:BAFmB
[[sql-pagination]] [[sql-pagination]]
=== Paginating through a large response === Paginating through a large response
Using the example above, one can continue to the next page by sending back the `cursor` field. In Using the example from the <<sql-rest-format,previous section>>, one can
case of text format the cursor is returned as `Cursor` http header. continue to the next page by sending back the cursor field. In case of text
format, the cursor is returned as `Cursor` http header.
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------