diff --git a/docs/examples/asStream.asciidoc b/docs/examples/asStream.asciidoc index 90975a262..a80fd549b 100644 --- a/docs/examples/asStream.asciidoc +++ b/docs/examples/asStream.asciidoc @@ -1,5 +1,5 @@ [[as_stream_examples]] -== asStream +=== asStream Instead of getting the parsed body back, you will get the raw Node.js stream of data. diff --git a/docs/examples/bulk.asciidoc b/docs/examples/bulk.asciidoc index a53cc8ba4..2f05b4cf1 100644 --- a/docs/examples/bulk.asciidoc +++ b/docs/examples/bulk.asciidoc @@ -1,5 +1,5 @@ [[bulk_examples]] -== Bulk +=== Bulk The `bulk` API makes it possible to perform many index/delete operations in a single API call. This can greatly increase the indexing speed. diff --git a/docs/examples/exists.asciidoc b/docs/examples/exists.asciidoc index dc8b42871..851f8c471 100644 --- a/docs/examples/exists.asciidoc +++ b/docs/examples/exists.asciidoc @@ -1,5 +1,5 @@ [[exists_examples]] -== Exists +=== Exists Check that the document `/game-of-thrones/1` exists. diff --git a/docs/examples/get.asciidoc b/docs/examples/get.asciidoc index 3fa0fd720..18caf1f4d 100644 --- a/docs/examples/get.asciidoc +++ b/docs/examples/get.asciidoc @@ -1,5 +1,5 @@ [[get_examples]] -== Get +=== Get The get API allows to get a typed JSON document from the index based on its id. The following example gets a JSON document from an index called diff --git a/docs/examples/ignore.asciidoc b/docs/examples/ignore.asciidoc index c7a40583d..a46f3e708 100644 --- a/docs/examples/ignore.asciidoc +++ b/docs/examples/ignore.asciidoc @@ -1,5 +1,6 @@ [[ignore_examples]] -== Ignore +=== Ignore + HTTP status codes which should not be considered errors for this request. [source,js] diff --git a/docs/examples/index.asciidoc b/docs/examples/index.asciidoc index fdc60a660..7aaf38f56 100644 --- a/docs/examples/index.asciidoc +++ b/docs/examples/index.asciidoc @@ -1,5 +1,5 @@ [[examples]] -= Examples +== Examples Following you can find some examples on how to use the client. diff --git a/docs/examples/msearch.asciidoc b/docs/examples/msearch.asciidoc index 49fadd1ea..3773318f4 100644 --- a/docs/examples/msearch.asciidoc +++ b/docs/examples/msearch.asciidoc @@ -1,5 +1,5 @@ [[msearch_examples]] -== MSearch +=== MSearch The multi search API allows to execute several search requests within the same API. diff --git a/docs/examples/reindex.asciidoc b/docs/examples/reindex.asciidoc index a99984d69..8ed6f1800 100644 --- a/docs/examples/reindex.asciidoc +++ b/docs/examples/reindex.asciidoc @@ -1,5 +1,5 @@ [[reindex_examples]] -== Reindex +=== Reindex The `reindex` API extracts the document source from the source index and indexes the documents into the destination index. You can copy all documents to the destination index, reindex a subset of the documents or update the source before to reindex it. diff --git a/docs/examples/scroll.asciidoc b/docs/examples/scroll.asciidoc index a1373af71..b7a9aa07b 100644 --- a/docs/examples/scroll.asciidoc +++ b/docs/examples/scroll.asciidoc @@ -1,5 +1,5 @@ [[scroll_examples]] -== Scroll +=== Scroll While a search request returns a single “page” of results, the scroll API can be used to retrieve large numbers of results (or even all results) from a single diff --git a/docs/examples/search.asciidoc b/docs/examples/search.asciidoc index 006804fe6..fb4fe4d2b 100644 --- a/docs/examples/search.asciidoc +++ b/docs/examples/search.asciidoc @@ -1,5 +1,5 @@ [[search_examples]] -== Search +=== Search The `search` API allows you to execute a search query and get back search hits that match the query. The query can either be provided using a simple diff --git a/docs/examples/sql.query.asciidoc b/docs/examples/sql.query.asciidoc index 651cb3c3d..50fb32841 100644 --- a/docs/examples/sql.query.asciidoc +++ b/docs/examples/sql.query.asciidoc @@ -1,5 +1,5 @@ [[sql_query_examples]] -== SQL +=== SQL Elasticsearch SQL is an X-Pack component that allows SQL-like queries to be executed in real-time against Elasticsearch. Whether using the REST interface, command-line or JDBC, any client can use SQL to search and aggregate data natively inside Elasticsearch. One can think of Elasticsearch SQL as a translator, one that understands both SQL and Elasticsearch and makes it easy to read and process data in real-time, at scale by leveraging Elasticsearch capabilities. diff --git a/docs/examples/suggest.asciidoc b/docs/examples/suggest.asciidoc index beaccf51f..b03ece4e1 100644 --- a/docs/examples/suggest.asciidoc +++ b/docs/examples/suggest.asciidoc @@ -1,5 +1,5 @@ [[suggest_examples]] -== Suggest +=== Suggest The suggest feature suggests similar looking terms based on a provided text by using a suggester. _Parts of the suggest feature are still under development._ diff --git a/docs/examples/transport.request.asciidoc b/docs/examples/transport.request.asciidoc index 385f61091..d74c6c68d 100644 --- a/docs/examples/transport.request.asciidoc +++ b/docs/examples/transport.request.asciidoc @@ -1,5 +1,5 @@ [[transport_request_examples]] -== transport.request +=== transport.request It can happen that you need to communicate with {es} by using an API that is not supported by the client, to mitigate this issue you can directly call diff --git a/docs/examples/typescript.asciidoc b/docs/examples/typescript.asciidoc index 4fb97e7f2..2d39ed2ac 100644 --- a/docs/examples/typescript.asciidoc +++ b/docs/examples/typescript.asciidoc @@ -1,5 +1,5 @@ [[typescript_examples]] -== Typescript +=== Typescript The client offers a first-class support for TypeScript, since it ships the type definitions for every exposed API. diff --git a/docs/examples/update.asciidoc b/docs/examples/update.asciidoc index ab08f79fb..c18a75ff7 100644 --- a/docs/examples/update.asciidoc +++ b/docs/examples/update.asciidoc @@ -1,5 +1,5 @@ [[update_examples]] -== Update +=== Update The update API allows updates of a specific document using the given script. + In the following example, we will index a document that also tracks how many times a character has said the given quote, and then we will update the `times` field. diff --git a/docs/examples/update_by_query.asciidoc b/docs/examples/update_by_query.asciidoc index 7d4a647e7..d7a9faee6 100644 --- a/docs/examples/update_by_query.asciidoc +++ b/docs/examples/update_by_query.asciidoc @@ -1,5 +1,5 @@ [[update_by_query_examples]] -== Update By Query +=== Update By Query The simplest usage of _update_by_query just performs an update on every document in the index without changing the source. This is useful to pick up a new property or some other online mapping change. diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 39600088d..86a193216 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -18,7 +18,7 @@ include::observability.asciidoc[] include::transport.asciidoc[] include::typescript.asciidoc[] include::reference.asciidoc[] +include::examples/index.asciidoc[] include::breaking-changes.asciidoc[] include::helpers.asciidoc[] -include::examples/index.asciidoc[] include::redirects.asciidoc[]