Skip to content

[7.x][DOCS] Rearranges Examples section in Node.JS book (#1425) #1431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples/asStream.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/bulk.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/exists.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[exists_examples]]
== Exists
=== Exists

Check that the document `/game-of-thrones/1` exists.

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/examples/ignore.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[[ignore_examples]]
== Ignore
=== Ignore

HTTP status codes which should not be considered errors for this request.

[source,js]
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[examples]]
= Examples
== Examples

Following you can find some examples on how to use the client.

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/msearch.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[msearch_examples]]
== MSearch
=== MSearch

The multi search API allows to execute several search requests within the same
API.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/reindex.asciidoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/scroll.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/search.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/sql.query.asciidoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/suggest.asciidoc
Original file line number Diff line number Diff line change
@@ -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._
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/transport.request.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/typescript.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/update.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/update_by_query.asciidoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]