Bump to 9.0.3 (#2888)

Workflow is not being triggered as expected

.buildkite/Dockerfile

@@ -1,4 +1,4 @@
-ARG NODE_VERSION=${NODE_VERSION:-18}
+ARG NODE_VERSION=${NODE_VERSION:-20}
 FROM node:$NODE_VERSION
 
 # Install required tools
@@ -12,5 +12,3 @@ WORKDIR /usr/src/app
 
 COPY package.json .
 RUN npm install
-
-COPY . .

.buildkite/Dockerfile-make

@@ -1,4 +1,4 @@
-ARG NODE_JS_VERSION=${NODE_JS_VERSION:-18}
+ARG NODE_JS_VERSION=${NODE_JS_VERSION:-20}
 FROM node:${NODE_JS_VERSION}
 
 ARG BUILDER_UID=1000
@@ -25,6 +25,3 @@ USER ${BUILDER_UID}:${BUILDER_GID}
 # install dependencies
 COPY package.json .
 RUN npm install
-
-# copy project files
-COPY . .

.buildkite/make.mjs

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 /* global $ argv */
@@ -123,7 +109,7 @@ async function codegen (args) {
   await $`rm -rf ${join(import.meta.url, '..', 'src', 'api')}`
   await $`mkdir ${join(import.meta.url, '..', 'src', 'api')}`
   await $`cp -R ${join(import.meta.url, '..', '..', 'elastic-client-generator-js', 'output')}/* ${join(import.meta.url, '..', 'src', 'api')}`
-  await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.asciidoc')} ${join(import.meta.url, '..', 'docs', 'reference.asciidoc')}`
+  await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.md')} ${join(import.meta.url, '..', 'docs', 'reference', 'api-reference.md')}`
   await $`npm run build`
 
   // run docs example generation

.buildkite/pipeline.yml

@@ -1,31 +1,31 @@
 ---
+agents:
+  provider: "gcp"
+  image: family/core-ubuntu-2204
+  memory: "8G"
+  cpu: "2"
+
 steps:
-  - label: ":elasticsearch: :javascript: ES JavaScript ({{ matrix.nodejs }}) Test Suite: {{ matrix.suite }}"
-    agents:
-      provider: "gcp"
+  - label: ":elasticsearch: :javascript: ES JavaScript ({{ matrix.nodejs }})"
     env:
       NODE_VERSION: "{{ matrix.nodejs }}"
-      TEST_SUITE: "{{ matrix.suite }}"
-      STACK_VERSION: 8.16.0
+      TEST_SUITE: "platinum"
+      STACK_VERSION: 9.0.0
+      GITHUB_TOKEN_PATH: "secret/ci/elastic-elasticsearch-js/github-token"
+      TEST_ES_STACK: "1"
     matrix:
       setup:
-        suite:
-          - "free"
-          - "platinum"
         nodejs:
-          - "18"
           - "20"
           - "22"
+          - "23"
     command: ./.buildkite/run-tests.sh
     artifact_paths: "./junit-output/junit-*.xml"
   - wait: ~
     continue_on_failure: true
   - label: ":junit: Test results"
-    agents:
-      provider: "gcp"
-      image: family/core-ubuntu-2204
     plugins:
-      - junit-annotate#v2.6.0:
+      - junit-annotate#v2.7.0:
           artifacts: "junit-output/junit-*.xml"
           job-uuid-file-pattern: "junit-(.*).xml"
           fail-build-on-error: true

.buildkite/run-client.sh

@@ -6,26 +6,33 @@ script_path=$(dirname "$(realpath -s "$0")")
 set -euo pipefail
 repo=$(pwd)
 
-export NODE_VERSION=${NODE_VERSION:-18}
+export NODE_VERSION=${NODE_VERSION:-20}
 
 echo "--- :javascript: Building Docker image"
 docker build \
-       --file "$script_path/Dockerfile" \
-       --tag elastic/elasticsearch-js \
-       --build-arg NODE_VERSION="$NODE_VERSION" \
-       .
+  --file "$script_path/Dockerfile" \
+  --tag elastic/elasticsearch-js \
+  --build-arg NODE_VERSION="$NODE_VERSION" \
+  .
 
-echo "--- :javascript: Running $TEST_SUITE tests"
+GITHUB_TOKEN=$(vault read -field=token "$GITHUB_TOKEN_PATH")
+export GITHUB_TOKEN
+
+echo "--- :javascript: Running tests"
 mkdir -p "$repo/junit-output"
 docker run \
-       --network="${network_name}" \
-       --env "TEST_ES_SERVER=${elasticsearch_url}" \
-       --env "ELASTIC_PASSWORD=${elastic_password}" \
-       --env "TEST_SUITE=${TEST_SUITE}" \
-       --env "ELASTIC_USER=elastic" \
-       --env "BUILDKITE=true" \
-       --volume "$repo/junit-output:/junit-output" \
-       --name elasticsearch-js \
-       --rm \
-       elastic/elasticsearch-js \
-       bash -c "npm run test:integration; [ -f ./$TEST_SUITE-report-junit.xml ] && mv ./$TEST_SUITE-report-junit.xml /junit-output/junit-$BUILDKITE_JOB_ID.xml || echo 'No JUnit artifact found'"
+  --network="${network_name}" \
+  --env TEST_ES_STACK \
+  --env STACK_VERSION \
+  --env GITHUB_TOKEN \
+  --env "TEST_ES_SERVER=${elasticsearch_url}" \
+  --env "ELASTIC_PASSWORD=${elastic_password}" \
+  --env "ELASTIC_USER=elastic" \
+  --env "BUILDKITE=true" \
+  --volume "/usr/src/app/node_modules" \
+  --volume "$repo:/usr/src/app" \
+  --volume "$repo/junit-output:/junit-output" \
+  --name elasticsearch-js \
+  --rm \
+  elastic/elasticsearch-js \
+  bash -c "npm run test:integration; [ -f ./report-junit.xml ] && mv ./report-junit.xml /junit-output/junit-$BUILDKITE_JOB_ID.xml || echo 'No JUnit artifact found'"

.dockerignore

@@ -6,3 +6,6 @@ elasticsearch
 lib
 junit-output
 .tap
+rest-api-spec
+yaml-rest-tests
+generated-tests

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+package.json @joshmock
+renovate.json @joshmock
+catalog-info.yaml @joshmock

.github/ISSUE_TEMPLATE/bug.yaml

@@ -40,7 +40,7 @@ body:
     id: node-js-version
     attributes:
       label: Node.js version
-      placeholder: 18.x, 20.x, etc.
+      placeholder: 20.x, 22.x, etc.
     validations:
       required: true
 

.github/workflows/docs-build.yml

@@ -16,4 +16,4 @@ jobs:
       deployments: write
       id-token: write
       contents: read
-      pull-requests: read
+      pull-requests: write

.github/workflows/nodejs.yml

@@ -32,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [18.x, 20.x, 22.x, 23.x]
+        node-version: [20.x, 22.x, 23.x]
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
@@ -41,7 +41,7 @@ jobs:
           persist-credentials: false
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -71,7 +71,7 @@ jobs:
           persist-credentials: false
 
       - name: Use Node.js
-        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 22.x
 
@@ -83,6 +83,9 @@ jobs:
         run: |
           npm run license-checker
 
+      - name: SPDX header check
+        run: npm run license-header
+
   test-bun:
     name: Test Bun
     runs-on: ${{ matrix.os }}
@@ -101,7 +104,7 @@ jobs:
           persist-credentials: false
 
       - name: Use Bun
-        uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2
+        uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2
 
       - name: Install
         run: |

.github/workflows/npm-publish-unstable.yml

@@ -0,0 +1,82 @@
+---
+name: Publish unstable builds to npm
+on:
+  push:
+    branches:
+      - main
+
+# kill in-progress action if another one is triggered
+concurrency:
+  group: publish-unstable
+  cancel-in-progress: true
+
+jobs:
+  # don't publish if source code has not changed
+  paths-filter:
+    name: Detect files changed
+    runs-on: ubuntu-latest
+    outputs:
+      src: "${{ steps.changes.outputs.src }}"
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          persist-credentials: false
+      - uses: dorny/paths-filter/@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        id: changes
+        with:
+          filters: |
+            src:
+              - 'src/**'
+              - 'package.json'
+              - 'tsconfig.json'
+              - 'index.d.ts'
+              - 'index.js'
+
+  test:
+    name: Run tests and publish unstable
+    if: ${{ needs.paths-filter.outputs.src == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      # pause for 30 minutes to avoid publishing more than 2x per hour
+      - name: Debounce 30 minutes
+        uses: zachary95/github-actions-debounce@ab7363483e2837992b8aa6be891763da00ac14f9 # v0.1.0
+        with:
+          wait: 1800
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          persist-credentials: false
+          ref: main
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version: "22.x"
+          registry-url: "https://registry.npmjs.org"
+      - name: Install dependencies
+        run: |
+          npm install -g npm
+          npm install
+      - name: Run tests
+        run: npm test
+
+  # if tests pass, publish unstable
+  publish:
+    name: Publish unstable
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: npm publish
+        run: |
+          # set unstable version value
+          unstable_tag=$(echo "unstable.$(date --utc +%Y%m%d%H%M%S)")
+          latest=$(npm view @elastic/elasticsearch --json | jq -r '.["dist-tags"].latest')
+          next=$(yes | npx semver -i minor "$latest")
+          unstable_version=$(echo "$next-$unstable_tag")
+
+          # overwrite package.json with unstable version value
+          mv package.json package.json.bak
+          jq --arg v "$unstable_version" ".version = $v" package.json.bak > package.json
+          rm package.json.bak
+
+          # publish to npm
+          npm publish --provenance --access public --tag "unstable"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/npm-publish.yml

@@ -16,26 +16,56 @@ jobs:
         with:
           persist-credentials: false
           ref: ${{ github.event.inputs.branch }}
-      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: "22.x"
           registry-url: "https://registry.npmjs.org"
       - run: npm install -g npm
       - run: npm install
       - run: npm test
-      - run: npm publish --provenance --access public --tag alpha
+      - name: npm publish
+        run: |
+          version=$(jq -r .version package.json)
+          tag_meta=$(echo "$version" | cut -s -d '-' -f2)
+          # if no meta info on the version (e.g. a '-alpha.1' prefix), publish as a stable release
+          if [[ -z "$tag_meta" ]]; then
+            # get latest version on npm
+            latest=$(npm view @elastic/elasticsearch --json | jq -r '.["dist-tags"].latest')
+
+            # if $version is higher than the most recently published version, publish as-is
+            if [[ $(yes | npx semver "$version" "$latest" | tail -n1) == "$version" ]]; then
+              npm publish --provenance --access public
+            else
+              # otherwise, publish with "previous" tag
+              npm publish --provenance --access public --tag "previous"
+            fi
+          else
+            # publish as a non-stable release using the meta name (e.g. 'alpha') as the tag
+            tag=$(echo "$tag_meta" | cut -d '.' -f1)
+            npm publish --provenance --access public --tag "$tag"
+          fi
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Publish version on GitHub
         run: |
           version=$(jq -r .version package.json)
-          gh release create \
-            -n "This is a 9.0.0 pre-release alpha. Changes may not be stable." \
-            --latest=false \
-            --prerelease \
-            --target "$BRANCH_NAME" \
-            --title "v$version" \
-            "v$version"
+          tag_meta=$(echo "$version" | cut -s -d '-' -f2)
+          if [[ -z "$tag_meta" ]]; then
+            gh release create \
+              -n "[Changelog](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/$BRANCH_NAME/changelog-client.html)"
+              --target "$BRANCH_NAME" \
+              --title "v$version" \
+              "v$version"
+          else
+            tag_main=$(echo "$version" | cut -d '-' -f1)
+            gh release create \
+              -n "This is a $tag_main pre-release. Changes may not be stable." \
+              --latest=false \
+              --prerelease \
+              --target "$BRANCH_NAME" \
+              --title "v$version" \
+              "v$version"
+          fi
         env:
           BRANCH_NAME: ${{ github.event.inputs.branch }}
           GH_TOKEN: ${{ github.token }}

.gitignore

@@ -68,3 +68,7 @@ bun.lockb
 test-results
 processinfo
 .tap
+rest-api-spec
+yaml-rest-tests
+generated-tests
+schema

.npmignore

@@ -74,3 +74,6 @@ CONTRIBUTING.md
 src
 bun.lockb
 .tap
+rest-api-spec
+yaml-rest-tests
+generated-tests

README.md

@@ -2,7 +2,7 @@
 
 # Elasticsearch Node.js client
 
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)  [![Build Status](https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg)](https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main)  [![Node CI](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg)](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml)  [![codecov](https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/elasticsearch-js)  [![NPM downloads](https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@elastic/elasticsearch)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Build Status](https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg)](https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main) [![Node CI](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg)](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml) [![codecov](https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/elasticsearch-js) [![NPM downloads](https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@elastic/elasticsearch)
 
 **[Download the latest version of Elasticsearch](https://www.elastic.co/downloads/elasticsearch)**
 or
@@ -34,25 +34,26 @@ the new features of the 8.13 version of Elasticsearch, the 8.13 client version
 is required for that. Elasticsearch language clients are only backwards
 compatible with default distributions and without guarantees made.
 
-| Elasticsearch Version | Elasticsearch-JS Branch  | Supported |
-| --------------------- | ------------------------ | --------- |
-| main                  | main                     |           |
-| 8.x                   | 8.x                      | 8.x       |
-| 7.x                   | 7.x                      | 7.17      |
+| Elasticsearch Version | Elasticsearch-JS Branch |
+| --------------------- | ----------------------- |
+| main                  | main                    |
+| 9.x                   | 9.x                     |
+| 8.x                   | 8.x                     |
+| 7.x                   | 7.x                     |
 
 ## Usage
 
-* [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)
-* [Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_indexing_documents)
-* [Getting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_getting_documents)
-* [Searching documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_searching_documents)
-* [Updating documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_updating_documents)
-* [Deleting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_documents)
-* [Deleting an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_an_index)
+- [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)
+- [Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_indexing_documents)
+- [Getting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_getting_documents)
+- [Searching documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_searching_documents)
+- [Updating documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_updating_documents)
+- [Deleting documents](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_documents)
+- [Deleting an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_an_index)
 
 ### Node.js support
 
-NOTE: The minimum supported version of Node.js is `v18`.
+NOTE: The minimum supported version of Node.js is `v20`.
 
 The client versioning follows the Elastic Stack versioning, this means that
 major, minor, and patch releases are done following a precise schedule that
@@ -65,58 +66,43 @@ to support that version for at least another minor release. If you are using the
 with a version of Node.js that will be unsupported soon, you will see a warning
 in your logs (the client will start logging the warning with two minors in advance).
 
-Unless you are **always** using a supported version of Node.js, 
+Unless you are **always** using a supported version of Node.js,
 we recommend defining the client dependency in your
 `package.json` with the `~` instead of `^`. In this way, you will lock the
 dependency on the minor release and not the major. (for example, `~7.10.0` instead
 of `^7.10.0`).
 
-| Node.js Version | Node.js EOL date | End of support         |
-| --------------- |------------------| ---------------------- |
-| `8.x`           | `December 2019`  | `7.11` (early 2021)    |
-| `10.x`          | `April 2021`     | `7.12` (mid 2021)      |
-| `12.x`          | `April 2022`     | `8.2` (early 2022)     |
-| `14.x`          | `April 2023`     | `8.8` (early 2023)     |
-| `16.x`          | `September 2023` | `8.11` (late 2023)     |
-
-### Compatibility
-
-Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
-Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
-
-| Elasticsearch Version | Client Version |
-| --------------------- |----------------|
-| `8.x`                 | `8.x`          |
-| `7.x`                 | `7.x`          |
-| `6.x`                 | `6.x`          |
-| `5.x`                 | `5.x`          |
-
-To install a specific major of the client, run the following command:
-```
-npm install @elastic/elasticsearch@<major>
-```
+| Node.js Version | Node.js EOL date | End of support      |
+| --------------- | ---------------- | ------------------- |
+| `8.x`           | `December 2019`  | `7.11` (early 2021) |
+| `10.x`          | `April 2021`     | `7.12` (mid 2021)   |
+| `12.x`          | `April 2022`     | `8.2` (early 2022)  |
+| `14.x`          | `April 2023`     | `8.8` (early 2023)  |
+| `16.x`          | `September 2023` | `8.11` (late 2023)  |
+| `18.x`          | `April 2025`     | `9.1` (mid 2025)    |
 
 #### Browser
 
 > [!WARNING]
 > There is no official support for the browser environment. It exposes your Elasticsearch instance to everyone, which could lead to security issues.
-We recommend that you write a lightweight proxy that uses this client instead, you can see a proxy example [here](./docs/examples/proxy).
+> We recommend that you write a lightweight proxy that uses this client instead, you can see a proxy example [here](./docs/examples/proxy).
 
 ## Documentation
 
-* [Introduction](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html)
-* [Usage](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#client-usage)
-* [Client configuration](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html)
-* [API reference](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html)
-* [Authentication](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication)
-* [Observability](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html)
-* [Creating a child client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/child.html)
-* [Client helpers](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html)
-* [Typescript support](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html)
-* [Testing](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-testing.html)
-* [Examples](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html)
+- [Introduction](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html)
+- [Usage](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#client-usage)
+- [Client configuration](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html)
+- [API reference](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html)
+- [Authentication](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication)
+- [Observability](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html)
+- [Creating a child client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/child.html)
+- [Client helpers](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html)
+- [Typescript support](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html)
+- [Testing](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-testing.html)
+- [Examples](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html)
 
 ## Install multiple versions
+
 If you are using multiple versions of Elasticsearch, you need to use multiple versions of the client. In the past, install multiple versions of the same package was not possible, but with `npm v6.9`, you can do that via aliasing.
 
 The command you must run to install different version of the client is:
@@ -161,7 +147,7 @@ client7.info().then(console.log, console.log)
 ```
 
 Finally, if you want to install the client for the next version of Elasticsearch
-*(the one that lives in Elasticsearch’s main branch)*, you can use the following
+_(the one that lives in Elasticsearch’s main branch)_, you can use the following
 command:
 
 ```sh

catalog-info.yaml

@@ -37,20 +37,7 @@ spec:
         everyone:
           access_level: READ_ONLY
       provider_settings:
-        build_pull_requests: false
+        build_pull_requests: true
         build_branches: false
+        separate_pull_request_statuses: true
       cancel_intermediate_builds: true
-      cancel_intermediate_builds_branch_filter: "!main"
-      schedules:
-        main:
-          branch: "main"
-          cronline: "@daily"
-        8_x:
-          branch: "8.x"
-          cronline: "@daily"
-        8_17:
-          branch: "8.17"
-          cronline: "@daily"
-        8_18:
-          branch: "8.18"
-          cronline: "@daily"

docs/doc_examples/0bee07a581c5776e068f6f4efad5a399.asciidoc

@@ -3,17 +3,11 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_query/async",
-  querystring: {
-    format: "json",
-  },
-  body: {
-    query:
-      "\n    FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index*\n    | STATS COUNT(http.response.status_code) BY user.id\n    | LIMIT 2\n  ",
-    include_ccs_metadata: true,
-  },
+const response = await client.esql.asyncQuery({
+  format: "json",
+  query:
+    "\n    FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index*\n    | STATS COUNT(http.response.status_code) BY user.id\n    | LIMIT 2\n  ",
+  include_ccs_metadata: true,
 });
 console.log(response);
 ----

docs/doc_examples/0dfde6a9d953822fd4b3aa0121ddd8fb.asciidoc

@@ -3,23 +3,20 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_application/search_application/my-app/_render_query",
-  body: {
-    params: {
-      query_string: "my first query",
-      text_fields: [
-        {
-          name: "title",
-          boost: 5,
-        },
-        {
-          name: "description",
-          boost: 1,
-        },
-      ],
-    },
+const response = await client.searchApplication.renderQuery({
+  name: "my-app",
+  params: {
+    query_string: "my first query",
+    text_fields: [
+      {
+        name: "title",
+        boost: 5,
+      },
+      {
+        name: "description",
+        boost: 1,
+      },
+    ],
   },
 });
 console.log(response);

docs/doc_examples/120fcf9f55128d6a81d5e87a9c235bbd.asciidoc

@@ -3,10 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_inference/chat_completion/openai-completion/_stream",
-  body: {
+const response = await client.inference.chatCompletionUnified({
+  inference_id: "openai-completion",
+  chat_completion_request: {
     model: "gpt-4o",
     messages: [
       {

docs/doc_examples/13d91782399ba1f291e103c18b5338cc.asciidoc

@@ -0,0 +1,25 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.createFrom({
+  source: "my-index",
+  dest: "my-new-index",
+  create_from: {
+    settings_override: {
+      index: {
+        number_of_shards: 5,
+      },
+    },
+    mappings_override: {
+      properties: {
+        field2: {
+          type: "boolean",
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/13ecdf99114098c76b050397d9c3d4e6.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "sparse_embedding",
+const response = await client.inference.sparseEmbedding({
   inference_id: "my-elser-model",
   input:
     "The sky above the port was the color of television tuned to a dead channel.",

docs/doc_examples/141ef0ebaa3b0772892b79b9bb85efb0.asciidoc

@@ -3,9 +3,8 @@
 
 [source, js]
 ----
-const response = await client.inference.put({
-  task_type: "my-inference-endpoint",
-  inference_id: "_update",
+const response = await client.inference.update({
+  inference_id: "my-inference-endpoint",
   inference_config: {
     service_settings: {
       api_key: "<API_KEY>",

docs/doc_examples/15ac33d641b376d9494075eb1f0d4066.asciidoc

@@ -0,0 +1,10 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.cancelMigrateReindex({
+  index: "my-data-stream",
+});
+console.log(response);
+----

docs/doc_examples/174b93c323aa8e9cc8ee2a3df5736810.asciidoc

@@ -0,0 +1,12 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.security.delegatePki({
+  x509_certificate_chain: [
+    "MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==",
+  ],
+});
+console.log(response);
+----

docs/doc_examples/19c00c6b29bc7dbc5e92b3668da2da93.asciidoc

@@ -3,27 +3,23 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_ingest/_simulate",
-  body: {
-    docs: [
-      {
-        _index: "my-index",
-        _id: "123",
-        _source: {
-          foo: "bar",
-        },
+const response = await client.simulate.ingest({
+  docs: [
+    {
+      _index: "my-index",
+      _id: "123",
+      _source: {
+        foo: "bar",
       },
-      {
-        _index: "my-index",
-        _id: "456",
-        _source: {
-          foo: "rab",
-        },
+    },
+    {
+      _index: "my-index",
+      _id: "456",
+      _source: {
+        foo: "rab",
       },
-    ],
-  },
+    },
+  ],
 });
 console.log(response);
 ----

docs/doc_examples/29aeabacb1fdf5b083d5f091b6d1bd44.asciidoc

@@ -0,0 +1,15 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.migrateReindex({
+  reindex: {
+    source: {
+      index: "my-data-stream",
+    },
+    mode: "upgrade",
+  },
+});
+console.log(response);
+----

docs/doc_examples/2a1eece9a59ac1773edcf0a932c26de0.asciidoc

@@ -3,14 +3,10 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/oidc/logout",
-  body: {
-    token:
-      "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
-    refresh_token: "vLBPvmAB6KvwvJZr27cS",
-  },
+const response = await client.security.oidcLogout({
+  token:
+    "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
+  refresh_token: "vLBPvmAB6KvwvJZr27cS",
 });
 console.log(response);
 ----

docs/doc_examples/2afdf0d83724953aa2875b5fb37d60cc.asciidoc

@@ -3,12 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "GET",
-  path: "/_query/async/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
-  querystring: {
-    wait_for_completion_timeout: "30s",
-  },
+const response = await client.esql.asyncQueryGet({
+  id: "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
+  wait_for_completion_timeout: "30s",
 });
 console.log(response);
 ----

docs/doc_examples/2f9ee29fe49f7d206a41212aa5945296.asciidoc

@@ -0,0 +1,22 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.createFrom({
+  source: "my-index",
+  dest: "my-new-index",
+  create_from: {
+    settings_override: {
+      index: {
+        "blocks.write": null,
+        "blocks.read": null,
+        "blocks.read_only": null,
+        "blocks.read_only_allow_delete": null,
+        "blocks.metadata": null,
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/3649194a97d265a3bc758f8b38f7561e.asciidoc

@@ -0,0 +1,21 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.create({
+  index: "semantic-embeddings",
+  mappings: {
+    properties: {
+      semantic_text: {
+        type: "semantic_text",
+      },
+      content: {
+        type: "text",
+        copy_to: "semantic_text",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/3f1fe5f5f99b98d0891f38003e10b636.asciidoc

@@ -3,14 +3,10 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_query/async",
-  body: {
-    query:
-      "\n    FROM library\n    | EVAL year = DATE_TRUNC(1 YEARS, release_date)\n    | STATS MAX(page_count) BY year\n    | SORT year\n    | LIMIT 5\n  ",
-    wait_for_completion_timeout: "2s",
-  },
+const response = await client.esql.asyncQuery({
+  query:
+    "\n    FROM library\n    | EVAL year = DATE_TRUNC(1 YEARS, release_date)\n    | STATS MAX(page_count) BY year\n    | SORT year\n    | LIMIT 5\n  ",
+  wait_for_completion_timeout: "2s",
 });
 console.log(response);
 ----

docs/doc_examples/405511f7c1f12cc0a227b4563fe7b2e2.asciidoc

@@ -3,9 +3,8 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "GET",
-  path: "/_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
+const response = await client.esql.asyncQueryGet({
+  id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
 });
 console.log(response);
 ----

docs/doc_examples/45954b8aaedfed57012be8b6538b0a24.asciidoc

@@ -3,10 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_inference/chat_completion/openai-completion/_stream",
-  body: {
+const response = await client.inference.chatCompletionUnified({
+  inference_id: "openai-completion",
+  chat_completion_request: {
     messages: [
       {
         role: "user",

docs/doc_examples/46b771a9932c3fa6057a7b2679c72ef0.asciidoc

@@ -0,0 +1,10 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.getMigrateReindexStatus({
+  index: "my-data-stream",
+});
+console.log(response);
+----

docs/doc_examples/4982c547be1ad9455ae836990aea92c5.asciidoc

@@ -6,6 +6,11 @@
 const response = await client.ml.startTrainedModelDeployment({
   model_id: "my_model",
   deployment_id: "my_model_for_search",
+  adaptive_allocations: {
+    enabled: true,
+    min_number_of_allocations: 3,
+    max_number_of_allocations: 10,
+  },
 });
 console.log(response);
 ----

docs/doc_examples/4b91ad7c9b44e07db4a4e81390f19ad3.asciidoc

@@ -3,12 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_inference/completion/openai-completion/_stream",
-  body: {
-    input: "What is Elastic?",
-  },
+const response = await client.inference.streamCompletion({
+  inference_id: "openai-completion",
+  input: "What is Elastic?",
 });
 console.log(response);
 ----

docs/doc_examples/57dc15e5ad663c342fd5c1d86fcd1b29.asciidoc

@@ -3,14 +3,10 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/oidc/prepare",
-  body: {
-    realm: "oidc1",
-    state: "lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO",
-    nonce: "zOBXLJGUooRrbLbQk5YCcyC8AXw3iloynvluYhZ5",
-  },
+const response = await client.security.oidcPrepareAuthentication({
+  realm: "oidc1",
+  state: "lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO",
+  nonce: "zOBXLJGUooRrbLbQk5YCcyC8AXw3iloynvluYhZ5",
 });
 console.log(response);
 ----

docs/doc_examples/5bba213a7f543190139d1a69ab2ed076.asciidoc

@@ -3,17 +3,11 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_query/async",
-  querystring: {
-    format: "json",
-  },
-  body: {
-    query:
-      "\n    FROM cluster_one:my-index*,cluster_two:logs*\n    | STATS COUNT(http.response.status_code) BY user.id\n    | LIMIT 2\n  ",
-    include_ccs_metadata: true,
-  },
+const response = await client.esql.asyncQuery({
+  format: "json",
+  query:
+    "\n    FROM cluster_one:my-index*,cluster_two:logs*\n    | STATS COUNT(http.response.status_code) BY user.id\n    | LIMIT 2\n  ",
+  include_ccs_metadata: true,
 });
 console.log(response);
 ----

docs/doc_examples/615dc36f0978c676624fb7d1144b4899.asciidoc

@@ -0,0 +1,11 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.getDataLifecycleStats({
+  human: "true",
+  pretty: "true",
+});
+console.log(response);
+----

docs/doc_examples/66915e95b723ee2f6e5164a94b8f98c1.asciidoc

@@ -0,0 +1,12 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.createFrom({
+  source: "my-index",
+  dest: "my-new-index",
+  create_from: null,
+});
+console.log(response);
+----

docs/doc_examples/67b71a95b6fe6c83faae51ea038a1bf1.asciidoc

@@ -0,0 +1,10 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.esql.asyncQueryDelete({
+  id: "FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=",
+});
+console.log(response);
+----

docs/doc_examples/6f3b723bf6179b96c3413597ed7f49e1.asciidoc

@@ -3,12 +3,8 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/api_key/_bulk_update",
-  body: {
-    ids: ["VuaCfGcBCdbkQm-e5aOx", "H3_AhoIBA9hmeQJdg7ij"],
-  },
+const response = await client.security.bulkUpdateApiKeys({
+  ids: ["VuaCfGcBCdbkQm-e5aOx", "H3_AhoIBA9hmeQJdg7ij"],
 });
 console.log(response);
 ----

docs/doc_examples/7429b16221fe741fd31b0584786dd0b0.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "text_embedding",
+const response = await client.inference.textEmbedding({
   inference_id: "my-cohere-endpoint",
   input:
     "The sky above the port was the color of television tuned to a dead channel.",

docs/doc_examples/77518e8c6198acfe77c0934fd2fe65cb.asciidoc

@@ -3,35 +3,31 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_text_structure/find_message_structure",
-  body: {
-    messages: [
-      "[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128",
-      "[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [repository-url]",
-      "[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [rest-root]",
-      "[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-core]",
-      "[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-redact]",
-      "[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [ingest-user-agent]",
-      "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-monitoring]",
-      "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [repository-s3]",
-      "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-analytics]",
-      "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-ent-search]",
-      "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-autoscaling]",
-      "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [lang-painless]]",
-      "[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [lang-expression]",
-      "[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-eql]",
-      "[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment    ] [laptop] heap size [16gb], compressed ordinary object pointers [true]",
-      "[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security         ] [laptop] Security is enabled",
-      "[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin  ] [laptop] Profiling is enabled",
-      "[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin  ] [laptop] profiling index templates will not be installed or reinstalled",
-      "[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]",
-      "[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule    ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]",
-      "[2024-03-05T10:52:49,188][INFO ][o.e.n.Node               ] [laptop] initialized",
-      "[2024-03-05T10:52:49,199][INFO ][o.e.n.Node               ] [laptop] starting ...",
-    ],
-  },
+const response = await client.textStructure.findMessageStructure({
+  messages: [
+    "[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128",
+    "[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [repository-url]",
+    "[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [rest-root]",
+    "[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-core]",
+    "[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-redact]",
+    "[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [ingest-user-agent]",
+    "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-monitoring]",
+    "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [repository-s3]",
+    "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-analytics]",
+    "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-ent-search]",
+    "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-autoscaling]",
+    "[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [lang-painless]]",
+    "[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [lang-expression]",
+    "[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService     ] [laptop] loaded module [x-pack-eql]",
+    "[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment    ] [laptop] heap size [16gb], compressed ordinary object pointers [true]",
+    "[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security         ] [laptop] Security is enabled",
+    "[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin  ] [laptop] Profiling is enabled",
+    "[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin  ] [laptop] profiling index templates will not be installed or reinstalled",
+    "[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]",
+    "[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule    ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]",
+    "[2024-03-05T10:52:49,188][INFO ][o.e.n.Node               ] [laptop] initialized",
+    "[2024-03-05T10:52:49,199][INFO ][o.e.n.Node               ] [laptop] starting ...",
+  ],
 });
 console.log(response);
 ----

docs/doc_examples/7ba29f0be2297b54a640b0a17d7ef5ca.asciidoc

@@ -3,9 +3,8 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "DELETE",
-  path: "/_ingest/ip_location/database/my-database-id",
+const response = await client.ingest.deleteIpLocationDatabase({
+  id: "my-database-id",
 });
 console.log(response);
 ----

docs/doc_examples/80dd7f5882c59b9c1c90e8351937441f.asciidoc

@@ -3,30 +3,26 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/api_key/_bulk_update",
-  body: {
-    ids: ["VuaCfGcBCdbkQm-e5aOx", "H3_AhoIBA9hmeQJdg7ij"],
-    role_descriptors: {
-      "role-a": {
-        indices: [
-          {
-            names: ["*"],
-            privileges: ["write"],
-          },
-        ],
-      },
+const response = await client.security.bulkUpdateApiKeys({
+  ids: ["VuaCfGcBCdbkQm-e5aOx", "H3_AhoIBA9hmeQJdg7ij"],
+  role_descriptors: {
+    "role-a": {
+      indices: [
+        {
+          names: ["*"],
+          privileges: ["write"],
+        },
+      ],
     },
-    metadata: {
-      environment: {
-        level: 2,
-        trusted: true,
-        tags: ["production"],
-      },
-    },
-    expiration: "30d",
   },
+  metadata: {
+    environment: {
+      level: 2,
+      trusted: true,
+      tags: ["production"],
+    },
+  },
+  expiration: "30d",
 });
 console.log(response);
 ----

docs/doc_examples/82bb6c61dab959f4446dc5ecab7ecbdf.asciidoc

@@ -3,10 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_inference/chat_completion/openai-completion/_stream",
-  body: {
+const response = await client.inference.chatCompletionUnified({
+  inference_id: "openai-completion",
+  chat_completion_request: {
     messages: [
       {
         role: "assistant",

docs/doc_examples/91e106a2affbc8df32cd940684a779ed.asciidoc

@@ -3,10 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "PUT",
-  path: "/_ingest/ip_location/database/my-database-1",
-  body: {
+const response = await client.ingest.putIpLocationDatabase({
+  id: "my-database-1",
+  configuration: {
     name: "GeoIP2-Domain",
     maxmind: {
       account_id: "1234567",

docs/doc_examples/947efe87db7f8813c0878f8affc3e2d1.asciidoc

@@ -0,0 +1,8 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.resolveCluster();
+console.log(response);
+----

docs/doc_examples/99fb82d49ac477e6a9dfdd71f9465374.asciidoc

@@ -3,9 +3,8 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "DELETE",
-  path: "/_ingest/ip_location/database/example-database-id",
+const response = await client.ingest.deleteIpLocationDatabase({
+  id: "example-database-id",
 });
 console.log(response);
 ----

docs/doc_examples/9afa0844883b7471883aa378a8dd10b4.asciidoc

@@ -3,10 +3,10 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_application/analytics/my_analytics_collection/event/search_click",
-  body: {
+const response = await client.searchApplication.postBehavioralAnalyticsEvent({
+  collection_name: "my_analytics_collection",
+  event_type: "search_click",
+  payload: {
     session: {
       id: "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9",
     },

docs/doc_examples/9c01db07c9ac395b6370e3b33965c21f.asciidoc

@@ -3,16 +3,12 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/oidc/authenticate",
-  body: {
-    redirect_uri:
-      "https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I",
-    state: "4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I",
-    nonce: "WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM",
-    realm: "oidc1",
-  },
+const response = await client.security.oidcAuthenticate({
+  redirect_uri:
+    "https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I",
+  state: "4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I",
+  nonce: "WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM",
+  realm: "oidc1",
 });
 console.log(response);
 ----

docs/doc_examples/a162eb50853331c80596f5994e9d1c38.asciidoc

@@ -3,13 +3,10 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_application/search_application/my_search_application/_render_query",
-  body: {
-    params: {
-      query_string: "rock climbing",
-    },
+const response = await client.searchApplication.renderQuery({
+  name: "my_search_application",
+  params: {
+    query_string: "rock climbing",
   },
 });
 console.log(response);

docs/doc_examples/a60aaed30d7d26eaacbb2c0ed4ddc66d.asciidoc

@@ -0,0 +1,10 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.cancelMigrateReindex({
+  index: "my-data-stream",
+});
+console.log(response);
+----

docs/doc_examples/adced6e22ef03c2ae3b14aa5bdd24fd9.asciidoc

@@ -0,0 +1,10 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.getMigrateReindexStatus({
+  index: "my-data-stream",
+});
+console.log(response);
+----

docs/doc_examples/b0bddf2ffaa83049b195829c06b875cd.asciidoc

@@ -3,9 +3,8 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_application/search_application/my_search_application/_render_query",
+const response = await client.searchApplication.renderQuery({
+  name: "my_search_application",
 });
 console.log(response);
 ----

docs/doc_examples/b1e81b70b874a1f0cf75a0ec6e430ddc.asciidoc

@@ -0,0 +1,10 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.esql.asyncQueryStop({
+  id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
+});
+console.log(response);
+----

docs/doc_examples/b45a8c6fc746e9c90fd181e69a605fad.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "completion",
+const response = await client.inference.completion({
   inference_id: "openai_chat_completions",
   input: "What is Elastic?",
 });

docs/doc_examples/b62eaa20c4e0e48134a6d1d1b3c30b26.asciidoc

@@ -208,13 +208,9 @@ const response = await client.bulk({
 });
 console.log(response);
 
-const response1 = await client.transport.request({
-  method: "GET",
-  path: "/_text_structure/find_field_structure",
-  querystring: {
-    index: "test-logs",
-    field: "message",
-  },
+const response1 = await client.textStructure.findFieldStructure({
+  index: "test-logs",
+  field: "message",
 });
 console.log(response1);
 ----

docs/doc_examples/bcdfaa4487747249699a86a0dcd22f5e.asciidoc

@@ -3,36 +3,32 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_ingest/_simulate",
-  body: {
-    docs: [
-      {
-        _index: "my-index",
-        _id: "123",
-        _source: {
-          foo: "bar",
-        },
+const response = await client.simulate.ingest({
+  docs: [
+    {
+      _index: "my-index",
+      _id: "123",
+      _source: {
+        foo: "bar",
       },
-      {
-        _index: "my-index",
-        _id: "456",
-        _source: {
-          foo: "rab",
-        },
+    },
+    {
+      _index: "my-index",
+      _id: "456",
+      _source: {
+        foo: "rab",
       },
-    ],
-    pipeline_substitutions: {
-      "my-pipeline": {
-        processors: [
-          {
-            uppercase: {
-              field: "foo",
-            },
+    },
+  ],
+  pipeline_substitutions: {
+    "my-pipeline": {
+      processors: [
+        {
+          uppercase: {
+            field: "foo",
           },
-        ],
-      },
+        },
+      ],
     },
   },
 });

docs/doc_examples/c580990a70028bb49cca8a6bde86bbf6.asciidoc

@@ -3,13 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/api_key/_bulk_update",
-  body: {
-    ids: ["VuaCfGcBCdbkQm-e5aOx", "H3_AhoIBA9hmeQJdg7ij"],
-    role_descriptors: {},
-  },
+const response = await client.security.bulkUpdateApiKeys({
+  ids: ["VuaCfGcBCdbkQm-e5aOx", "H3_AhoIBA9hmeQJdg7ij"],
+  role_descriptors: {},
 });
 console.log(response);
 ----

docs/doc_examples/ccc613951c61f0b17e1ed8a2d3ae54a2.asciidoc

@@ -3,69 +3,65 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_ingest/_simulate",
-  body: {
-    docs: [
-      {
-        _index: "my-index",
-        _id: "id",
-        _source: {
-          foo: "bar",
-        },
-      },
-      {
-        _index: "my-index",
-        _id: "id",
-        _source: {
-          foo: "rab",
-        },
-      },
-    ],
-    pipeline_substitutions: {
-      "my-pipeline": {
-        processors: [
-          {
-            set: {
-              field: "field3",
-              value: "value3",
-            },
-          },
-        ],
+const response = await client.simulate.ingest({
+  docs: [
+    {
+      _index: "my-index",
+      _id: "id",
+      _source: {
+        foo: "bar",
       },
     },
-    component_template_substitutions: {
-      "my-component-template": {
-        template: {
-          mappings: {
-            dynamic: "true",
-            properties: {
-              field3: {
-                type: "keyword",
-              },
+    {
+      _index: "my-index",
+      _id: "id",
+      _source: {
+        foo: "rab",
+      },
+    },
+  ],
+  pipeline_substitutions: {
+    "my-pipeline": {
+      processors: [
+        {
+          set: {
+            field: "field3",
+            value: "value3",
+          },
+        },
+      ],
+    },
+  },
+  component_template_substitutions: {
+    "my-component-template": {
+      template: {
+        mappings: {
+          dynamic: "true",
+          properties: {
+            field3: {
+              type: "keyword",
             },
           },
-          settings: {
-            index: {
-              default_pipeline: "my-pipeline",
-            },
+        },
+        settings: {
+          index: {
+            default_pipeline: "my-pipeline",
           },
         },
       },
     },
-    index_template_substitutions: {
-      "my-index-template": {
-        index_patterns: ["my-index-*"],
-        composed_of: ["component_template_1", "component_template_2"],
-      },
+  },
+  index_template_substitutions: {
+    "my-index-template": {
+      index_patterns: ["my-index-*"],
+      composed_of: ["component_template_1", "component_template_2"],
     },
-    mapping_addition: {
-      dynamic: "strict",
-      properties: {
-        foo: {
-          type: "keyword",
-        },
+  },
+  mapping_addition: {
+    dynamic: "strict",
+    properties: {
+      foo: {
+        type: "keyword",
       },
     },
   },

docs/doc_examples/d35c8cf7a98b3f112e1de8797ec6689d.asciidoc

@@ -3,13 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/oidc/prepare",
-  body: {
-    iss: "http://127.0.0.1:8080",
-    login_hint: "this_is_an_opaque_string",
-  },
+const response = await client.security.oidcPrepareAuthentication({
+  iss: "http://127.0.0.1:8080",
+  login_hint: "this_is_an_opaque_string",
 });
 console.log(response);
 ----

docs/doc_examples/d4df39f72d3a3b80cd4042f6a21c3f19.asciidoc

@@ -3,10 +3,9 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "PUT",
-  path: "/_ingest/ip_location/database/my-database-2",
-  body: {
+const response = await client.ingest.putIpLocationDatabase({
+  id: "my-database-2",
+  configuration: {
     name: "standard_location",
     ipinfo: {},
   },

docs/doc_examples/d8c053ee26c1533ce936ec81101d8e1b.asciidoc

@@ -3,9 +3,8 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "GET",
-  path: "/_ingest/ip_location/database/my-database-id",
+const response = await client.ingest.getIpLocationDatabase({
+  id: "my-database-id",
 });
 console.log(response);
 ----

docs/doc_examples/dd71b0c9f9197684ff29c61062c55660.asciidoc

@@ -3,9 +3,6 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "GET",
-  path: "/_security/settings",
-});
+const response = await client.security.getSettings();
 console.log(response);
 ----

docs/doc_examples/dde92fdf3469349ffe2c81764333543a.asciidoc

@@ -0,0 +1,14 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.createFrom({
+  source: "my-index",
+  dest: "my-new-index",
+  create_from: {
+    remove_index_blocks: false,
+  },
+});
+console.log(response);
+----

docs/doc_examples/e3019fd5f23458ae49ad9854c97d321c.asciidoc

@@ -3,12 +3,8 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_security/oidc/prepare",
-  body: {
-    realm: "oidc1",
-  },
+const response = await client.security.oidcPrepareAuthentication({
+  realm: "oidc1",
 });
 console.log(response);
 ----

docs/doc_examples/e4b38973c74037335378d8480f1ce894.asciidoc

@@ -3,38 +3,34 @@
 
 [source, js]
 ----
-const response = await client.transport.request({
-  method: "POST",
-  path: "/_ingest/_simulate",
-  body: {
-    docs: [
-      {
-        _index: "my-index",
-        _id: "123",
-        _source: {
-          foo: "foo",
-        },
+const response = await client.simulate.ingest({
+  docs: [
+    {
+      _index: "my-index",
+      _id: "123",
+      _source: {
+        foo: "foo",
       },
-      {
-        _index: "my-index",
-        _id: "456",
-        _source: {
-          bar: "rab",
-        },
+    },
+    {
+      _index: "my-index",
+      _id: "456",
+      _source: {
+        bar: "rab",
       },
-    ],
-    component_template_substitutions: {
-      "my-mappings_template": {
-        template: {
-          mappings: {
-            dynamic: "strict",
-            properties: {
-              foo: {
-                type: "keyword",
-              },
-              bar: {
-                type: "keyword",
-              },
+    },
+  ],
+  component_template_substitutions: {
+    "my-mappings_template": {
+      template: {
+        mappings: {
+          dynamic: "strict",
+          properties: {
+            foo: {
+              type: "keyword",
+            },
+            bar: {
+              type: "keyword",
             },
           },
         },

docs/doc_examples/ec135f0cc0d3f526df68000b2a95c65b.asciidoc

@@ -0,0 +1,12 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.createFrom({
+  source: ".ml-anomalies-custom-example",
+  dest: ".reindexed-v9-ml-anomalies-custom-example",
+  create_from: null,
+});
+console.log(response);
+----

docs/doc_examples/f1b24217b1d9ba6ea5e4fa6e6f412022.asciidoc

@@ -3,8 +3,7 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
-  task_type: "rerank",
+const response = await client.inference.rerank({
   inference_id: "cohere_rerank",
   input: ["luke", "like", "leia", "chewy", "r2d2", "star", "wars"],
   query: "star wars main character",

docs/docset.yml

@@ -1,4 +1,6 @@
 project: 'Node.js client'
+products:
+  - id: elasticsearch-client
 exclude:
   - examples/proxy/README.md
 cross_links:
@@ -8,482 +10,5 @@ toc:
   - toc: reference
   - toc: release-notes
 subs:
-  ref:   "https://www.elastic.co/guide/en/elasticsearch/reference/current"
-  ref-bare:   "https://www.elastic.co/guide/en/elasticsearch/reference"
-  ref-8x:   "https://www.elastic.co/guide/en/elasticsearch/reference/8.1"
-  ref-80:   "https://www.elastic.co/guide/en/elasticsearch/reference/8.0"
-  ref-7x:   "https://www.elastic.co/guide/en/elasticsearch/reference/7.17"
-  ref-70:   "https://www.elastic.co/guide/en/elasticsearch/reference/7.0"
-  ref-60:   "https://www.elastic.co/guide/en/elasticsearch/reference/6.0"
-  ref-64:   "https://www.elastic.co/guide/en/elasticsearch/reference/6.4"
-  xpack-ref:   "https://www.elastic.co/guide/en/x-pack/6.2"
-  logstash-ref:   "https://www.elastic.co/guide/en/logstash/current"
-  kibana-ref:   "https://www.elastic.co/guide/en/kibana/current"
-  kibana-ref-all:   "https://www.elastic.co/guide/en/kibana"
-  beats-ref-root:   "https://www.elastic.co/guide/en/beats"
-  beats-ref:   "https://www.elastic.co/guide/en/beats/libbeat/current"
-  beats-ref-60:   "https://www.elastic.co/guide/en/beats/libbeat/6.0"
-  beats-ref-63:   "https://www.elastic.co/guide/en/beats/libbeat/6.3"
-  beats-devguide:   "https://www.elastic.co/guide/en/beats/devguide/current"
-  auditbeat-ref:   "https://www.elastic.co/guide/en/beats/auditbeat/current"
-  packetbeat-ref:   "https://www.elastic.co/guide/en/beats/packetbeat/current"
-  metricbeat-ref:   "https://www.elastic.co/guide/en/beats/metricbeat/current"
-  filebeat-ref:   "https://www.elastic.co/guide/en/beats/filebeat/current"
-  functionbeat-ref:   "https://www.elastic.co/guide/en/beats/functionbeat/current"
-  winlogbeat-ref:   "https://www.elastic.co/guide/en/beats/winlogbeat/current"
-  heartbeat-ref:   "https://www.elastic.co/guide/en/beats/heartbeat/current"
-  journalbeat-ref:   "https://www.elastic.co/guide/en/beats/journalbeat/current"
-  ingest-guide:   "https://www.elastic.co/guide/en/ingest/current"
-  fleet-guide:   "https://www.elastic.co/guide/en/fleet/current"
-  apm-guide-ref:   "https://www.elastic.co/guide/en/apm/guide/current"
-  apm-guide-7x:   "https://www.elastic.co/guide/en/apm/guide/7.17"
-  apm-app-ref:   "https://www.elastic.co/guide/en/kibana/current"
-  apm-agents-ref:   "https://www.elastic.co/guide/en/apm/agent"
-  apm-android-ref:   "https://www.elastic.co/guide/en/apm/agent/android/current"
-  apm-py-ref:   "https://www.elastic.co/guide/en/apm/agent/python/current"
-  apm-py-ref-3x:   "https://www.elastic.co/guide/en/apm/agent/python/3.x"
-  apm-node-ref-index:   "https://www.elastic.co/guide/en/apm/agent/nodejs"
-  apm-node-ref:   "https://www.elastic.co/guide/en/apm/agent/nodejs/current"
-  apm-node-ref-1x:   "https://www.elastic.co/guide/en/apm/agent/nodejs/1.x"
-  apm-rum-ref:   "https://www.elastic.co/guide/en/apm/agent/rum-js/current"
-  apm-ruby-ref:   "https://www.elastic.co/guide/en/apm/agent/ruby/current"
-  apm-java-ref:   "https://www.elastic.co/guide/en/apm/agent/java/current"
-  apm-go-ref:   "https://www.elastic.co/guide/en/apm/agent/go/current"
-  apm-dotnet-ref:   "https://www.elastic.co/guide/en/apm/agent/dotnet/current"
-  apm-php-ref:   "https://www.elastic.co/guide/en/apm/agent/php/current"
-  apm-ios-ref:   "https://www.elastic.co/guide/en/apm/agent/swift/current"
-  apm-lambda-ref:   "https://www.elastic.co/guide/en/apm/lambda/current"
-  apm-attacher-ref:   "https://www.elastic.co/guide/en/apm/attacher/current"
-  docker-logging-ref:   "https://www.elastic.co/guide/en/beats/loggingplugin/current"
-  esf-ref:   "https://www.elastic.co/guide/en/esf/current"
-  kinesis-firehose-ref:   "https://www.elastic.co/guide/en/kinesis/{{kinesis_version}}"
-  estc-welcome-current:   "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current"
-  estc-welcome:   "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current"
-  estc-welcome-all:   "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions"
-  hadoop-ref:   "https://www.elastic.co/guide/en/elasticsearch/hadoop/current"
-  stack-ref:   "https://www.elastic.co/guide/en/elastic-stack/current"
-  stack-ref-67:   "https://www.elastic.co/guide/en/elastic-stack/6.7"
-  stack-ref-68:   "https://www.elastic.co/guide/en/elastic-stack/6.8"
-  stack-ref-70:   "https://www.elastic.co/guide/en/elastic-stack/7.0"
-  stack-ref-80:   "https://www.elastic.co/guide/en/elastic-stack/8.0"
-  stack-ov:   "https://www.elastic.co/guide/en/elastic-stack-overview/current"
-  stack-gs:   "https://www.elastic.co/guide/en/elastic-stack-get-started/current"
-  stack-gs-current:   "https://www.elastic.co/guide/en/elastic-stack-get-started/current"
-  javaclient:   "https://www.elastic.co/guide/en/elasticsearch/client/java-api/current"
-  java-api-client:   "https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current"
-  java-rest:   "https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current"
-  jsclient:   "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current"
-  jsclient-current:   "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current"
-  es-ruby-client:   "https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current"
-  es-dotnet-client:   "https://www.elastic.co/guide/en/elasticsearch/client/net-api/current"
-  es-php-client:   "https://www.elastic.co/guide/en/elasticsearch/client/php-api/current"
-  es-python-client:   "https://www.elastic.co/guide/en/elasticsearch/client/python-api/current"
-  defguide:   "https://www.elastic.co/guide/en/elasticsearch/guide/2.x"
-  painless:   "https://www.elastic.co/guide/en/elasticsearch/painless/current"
-  plugins:   "https://www.elastic.co/guide/en/elasticsearch/plugins/current"
-  plugins-8x:   "https://www.elastic.co/guide/en/elasticsearch/plugins/8.1"
-  plugins-7x:   "https://www.elastic.co/guide/en/elasticsearch/plugins/7.17"
-  plugins-6x:   "https://www.elastic.co/guide/en/elasticsearch/plugins/6.8"
-  glossary:   "https://www.elastic.co/guide/en/elastic-stack-glossary/current"
-  upgrade_guide:   "https://www.elastic.co/products/upgrade_guide"
-  blog-ref:   "https://www.elastic.co/blog/"
-  curator-ref:   "https://www.elastic.co/guide/en/elasticsearch/client/curator/current"
-  curator-ref-current:   "https://www.elastic.co/guide/en/elasticsearch/client/curator/current"
-  metrics-ref:   "https://www.elastic.co/guide/en/metrics/current"
-  metrics-guide:   "https://www.elastic.co/guide/en/metrics/guide/current"
-  logs-ref:   "https://www.elastic.co/guide/en/logs/current"
-  logs-guide:   "https://www.elastic.co/guide/en/logs/guide/current"
-  uptime-guide:   "https://www.elastic.co/guide/en/uptime/current"
-  observability-guide:   "https://www.elastic.co/guide/en/observability/current"
-  observability-guide-all:   "https://www.elastic.co/guide/en/observability"
-  siem-guide:   "https://www.elastic.co/guide/en/siem/guide/current"
-  security-guide:   "https://www.elastic.co/guide/en/security/current"
-  security-guide-all:   "https://www.elastic.co/guide/en/security"
-  endpoint-guide:   "https://www.elastic.co/guide/en/endpoint/current"
-  sql-odbc:   "https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current"
-  ecs-ref:   "https://www.elastic.co/guide/en/ecs/current"
-  ecs-logging-ref:   "https://www.elastic.co/guide/en/ecs-logging/overview/current"
-  ecs-logging-go-logrus-ref:   "https://www.elastic.co/guide/en/ecs-logging/go-logrus/current"
-  ecs-logging-go-zap-ref:   "https://www.elastic.co/guide/en/ecs-logging/go-zap/current"
-  ecs-logging-go-zerolog-ref:   "https://www.elastic.co/guide/en/ecs-logging/go-zap/current"
-  ecs-logging-java-ref:   "https://www.elastic.co/guide/en/ecs-logging/java/current"
-  ecs-logging-dotnet-ref:   "https://www.elastic.co/guide/en/ecs-logging/dotnet/current"
-  ecs-logging-nodejs-ref:   "https://www.elastic.co/guide/en/ecs-logging/nodejs/current"
-  ecs-logging-php-ref:   "https://www.elastic.co/guide/en/ecs-logging/php/current"
-  ecs-logging-python-ref:   "https://www.elastic.co/guide/en/ecs-logging/python/current"
-  ecs-logging-ruby-ref:   "https://www.elastic.co/guide/en/ecs-logging/ruby/current"
-  ml-docs:   "https://www.elastic.co/guide/en/machine-learning/current"
-  eland-docs:   "https://www.elastic.co/guide/en/elasticsearch/client/eland/current"
-  eql-ref:   "https://eql.readthedocs.io/en/latest/query-guide"
-  extendtrial:   "https://www.elastic.co/trialextension"
-  wikipedia:   "https://en.wikipedia.org/wiki"
-  forum:   "https://discuss.elastic.co/"
-  xpack-forum:   "https://discuss.elastic.co/c/50-x-pack"
-  security-forum:   "https://discuss.elastic.co/c/x-pack/shield"
-  watcher-forum:   "https://discuss.elastic.co/c/x-pack/watcher"
-  monitoring-forum:   "https://discuss.elastic.co/c/x-pack/marvel"
-  graph-forum:   "https://discuss.elastic.co/c/x-pack/graph"
-  apm-forum:   "https://discuss.elastic.co/c/apm"
-  enterprise-search-ref:   "https://www.elastic.co/guide/en/enterprise-search/current"
-  app-search-ref:   "https://www.elastic.co/guide/en/app-search/current"
-  workplace-search-ref:   "https://www.elastic.co/guide/en/workplace-search/current"
-  enterprise-search-node-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current"
-  enterprise-search-php-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/php/current"
-  enterprise-search-python-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/python/current"
-  enterprise-search-ruby-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current"
-  elastic-maps-service:   "https://maps.elastic.co"
-  integrations-docs:   "https://docs.elastic.co/en/integrations"
-  integrations-devguide:   "https://www.elastic.co/guide/en/integrations-developer/current"
-  time-units:   "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units"
-  byte-units:   "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units"
-  apm-py-ref-v:   "https://www.elastic.co/guide/en/apm/agent/python/current"
-  apm-node-ref-v:   "https://www.elastic.co/guide/en/apm/agent/nodejs/current"
-  apm-rum-ref-v:   "https://www.elastic.co/guide/en/apm/agent/rum-js/current"
-  apm-ruby-ref-v:   "https://www.elastic.co/guide/en/apm/agent/ruby/current"
-  apm-java-ref-v:   "https://www.elastic.co/guide/en/apm/agent/java/current"
-  apm-go-ref-v:   "https://www.elastic.co/guide/en/apm/agent/go/current"
-  apm-ios-ref-v:   "https://www.elastic.co/guide/en/apm/agent/swift/current"
-  apm-dotnet-ref-v:   "https://www.elastic.co/guide/en/apm/agent/dotnet/current"
-  apm-php-ref-v:   "https://www.elastic.co/guide/en/apm/agent/php/current"
-  ecloud:   "Elastic Cloud"
-  esf:   "Elastic Serverless Forwarder"
-  ess:   "Elasticsearch Service"
-  ece:   "Elastic Cloud Enterprise"
-  eck:   "Elastic Cloud on Kubernetes"
-  serverless-full:   "Elastic Cloud Serverless"
-  serverless-short:   "Serverless"
-  es-serverless:   "Elasticsearch Serverless"
-  es3:   "Elasticsearch Serverless"
-  obs-serverless:   "Elastic Observability Serverless"
-  sec-serverless:   "Elastic Security Serverless"
-  serverless-docs:   "https://docs.elastic.co/serverless"
-  cloud:   "https://www.elastic.co/guide/en/cloud/current"
-  ess-utm-params:   "?page=docs&placement=docs-body"
-  ess-baymax:   "?page=docs&placement=docs-body"
-  ess-trial:   "https://cloud.elastic.co/registration?page=docs&placement=docs-body"
-  ess-product:   "https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body"
-  ess-console:   "https://cloud.elastic.co?page=docs&placement=docs-body"
-  ess-console-name:   "Elasticsearch Service Console"
-  ess-deployments:   "https://cloud.elastic.co/deployments?page=docs&placement=docs-body"
-  ece-ref:   "https://www.elastic.co/guide/en/cloud-enterprise/current"
-  eck-ref:   "https://www.elastic.co/guide/en/cloud-on-k8s/current"
-  ess-leadin:   "You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try the Elasticsearch Service for free]."
-  ess-leadin-short:   "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it for free]."
-  ess-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elasticsearch Service\"]"
-  ece-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elastic Cloud Enterprise\"]"
-  cloud-only:   "This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic Cloud on Kubernetes]. Direct use is not supported."
-  ess-setting-change:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"{ess-trial}\", title=\"Supported on {ess}\"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user setting] for Elasticsearch Service."
-  ess-skip-section:   "If you use Elasticsearch Service, skip this section. Elasticsearch Service handles these changes for you."
-  api-cloud:   "https://www.elastic.co/docs/api/doc/cloud"
-  api-ece:   "https://www.elastic.co/docs/api/doc/cloud-enterprise"
-  api-kibana-serverless:   "https://www.elastic.co/docs/api/doc/serverless"
-  es-feature-flag:   "This feature is in development and not yet available for use. This documentation is provided for informational purposes only."
-  es-ref-dir:   "'{{elasticsearch-root}}/docs/reference'"
-  apm-app:   "APM app"
-  uptime-app:   "Uptime app"
-  synthetics-app:   "Synthetics app"
-  logs-app:   "Logs app"
-  metrics-app:   "Metrics app"
-  infrastructure-app:   "Infrastructure app"
-  siem-app:   "SIEM app"
-  security-app:   "Elastic Security app"
-  ml-app:   "Machine Learning"
-  dev-tools-app:   "Dev Tools"
-  ingest-manager-app:   "Ingest Manager"
-  stack-manage-app:   "Stack Management"
-  stack-monitor-app:   "Stack Monitoring"
-  alerts-ui:   "Alerts and Actions"
-  rules-ui:   "Rules"
-  rac-ui:   "Rules and Connectors"
-  connectors-ui:   "Connectors"
-  connectors-feature:   "Actions and Connectors"
-  stack-rules-feature:   "Stack Rules"
-  user-experience:   "User Experience"
-  ems:   "Elastic Maps Service"
-  ems-init:   "EMS"
-  hosted-ems:   "Elastic Maps Server"
-  ipm-app:   "Index Pattern Management"
-  ingest-pipelines:   "ingest pipelines"
-  ingest-pipelines-app:   "Ingest Pipelines"
-  ingest-pipelines-cap:   "Ingest pipelines"
-  ls-pipelines:   "Logstash pipelines"
-  ls-pipelines-app:   "Logstash Pipelines"
-  maint-windows:   "maintenance windows"
-  maint-windows-app:   "Maintenance Windows"
-  maint-windows-cap:   "Maintenance windows"
-  custom-roles-app:   "Custom Roles"
-  data-source:   "data view"
-  data-sources:   "data views"
-  data-source-caps:   "Data View"
-  data-sources-caps:   "Data Views"
-  data-source-cap:   "Data view"
-  data-sources-cap:   "Data views"
-  project-settings:   "Project settings"
-  manage-app:   "Management"
-  index-manage-app:   "Index Management"
-  data-views-app:   "Data Views"
-  rules-app:   "Rules"
-  saved-objects-app:   "Saved Objects"
-  tags-app:   "Tags"
-  api-keys-app:   "API keys"
-  transforms-app:   "Transforms"
-  connectors-app:   "Connectors"
-  files-app:   "Files"
-  reports-app:   "Reports"
-  maps-app:   "Maps"
-  alerts-app:   "Alerts"
-  crawler:   "Enterprise Search web crawler"
-  ents:   "Enterprise Search"
-  app-search-crawler:   "App Search web crawler"
-  agent:   "Elastic Agent"
-  agents:   "Elastic Agents"
-  fleet:   "Fleet"
-  fleet-server:   "Fleet Server"
-  integrations-server:   "Integrations Server"
-  ingest-manager:   "Ingest Manager"
-  ingest-management:   "ingest management"
-  package-manager:   "Elastic Package Manager"
-  integrations:   "Integrations"
-  package-registry:   "Elastic Package Registry"
-  artifact-registry:   "Elastic Artifact Registry"
-  aws:   "AWS"
   stack:   "Elastic Stack"
-  xpack:   "X-Pack"
   es:   "Elasticsearch"
-  kib:   "Kibana"
-  esms:   "Elastic Stack Monitoring Service"
-  esms-init:   "ESMS"
-  ls:   "Logstash"
-  beats:   "Beats"
-  auditbeat:   "Auditbeat"
-  filebeat:   "Filebeat"
-  heartbeat:   "Heartbeat"
-  metricbeat:   "Metricbeat"
-  packetbeat:   "Packetbeat"
-  winlogbeat:   "Winlogbeat"
-  functionbeat:   "Functionbeat"
-  journalbeat:   "Journalbeat"
-  es-sql:   "Elasticsearch SQL"
-  esql:   "ES|QL"
-  elastic-agent:   "Elastic Agent"
-  k8s:   "Kubernetes"
-  log-driver-long:   "Elastic Logging Plugin for Docker"
-  security:   "X-Pack security"
-  security-features:   "security features"
-  operator-feature:   "operator privileges feature"
-  es-security-features:   "Elasticsearch security features"
-  stack-security-features:   "Elastic Stack security features"
-  endpoint-sec:   "Endpoint Security"
-  endpoint-cloud-sec:   "Endpoint and Cloud Security"
-  elastic-defend:   "Elastic Defend"
-  elastic-sec:   "Elastic Security"
-  elastic-endpoint:   "Elastic Endpoint"
-  swimlane:   "Swimlane"
-  sn:   "ServiceNow"
-  sn-itsm:   "ServiceNow ITSM"
-  sn-itom:   "ServiceNow ITOM"
-  sn-sir:   "ServiceNow SecOps"
-  jira:   "Jira"
-  ibm-r:   "IBM Resilient"
-  webhook:   "Webhook"
-  webhook-cm:   "Webhook - Case Management"
-  opsgenie:   "Opsgenie"
-  bedrock:   "Amazon Bedrock"
-  gemini:   "Google Gemini"
-  hive:   "TheHive"
-  monitoring:   "X-Pack monitoring"
-  monitor-features:   "monitoring features"
-  stack-monitor-features:   "Elastic Stack monitoring features"
-  watcher:   "Watcher"
-  alert-features:   "alerting features"
-  reporting:   "X-Pack reporting"
-  report-features:   "reporting features"
-  graph:   "X-Pack graph"
-  graph-features:   "graph analytics features"
-  searchprofiler:   "Search Profiler"
-  xpackml:   "X-Pack machine learning"
-  ml:   "machine learning"
-  ml-cap:   "Machine learning"
-  ml-init:   "ML"
-  ml-features:   "machine learning features"
-  stack-ml-features:   "Elastic Stack machine learning features"
-  ccr:   "cross-cluster replication"
-  ccr-cap:   "Cross-cluster replication"
-  ccr-init:   "CCR"
-  ccs:   "cross-cluster search"
-  ccs-cap:   "Cross-cluster search"
-  ccs-init:   "CCS"
-  ilm:   "index lifecycle management"
-  ilm-cap:   "Index lifecycle management"
-  ilm-init:   "ILM"
-  dlm:   "data lifecycle management"
-  dlm-cap:   "Data lifecycle management"
-  dlm-init:   "DLM"
-  search-snap:   "searchable snapshot"
-  search-snaps:   "searchable snapshots"
-  search-snaps-cap:   "Searchable snapshots"
-  slm:   "snapshot lifecycle management"
-  slm-cap:   "Snapshot lifecycle management"
-  slm-init:   "SLM"
-  rollup-features:   "data rollup features"
-  ipm:   "index pattern management"
-  ipm-cap:   "Index pattern"
-  rollup:   "rollup"
-  rollup-cap:   "Rollup"
-  rollups:   "rollups"
-  rollups-cap:   "Rollups"
-  rollup-job:   "rollup job"
-  rollup-jobs:   "rollup jobs"
-  rollup-jobs-cap:   "Rollup jobs"
-  dfeed:   "datafeed"
-  dfeeds:   "datafeeds"
-  dfeed-cap:   "Datafeed"
-  dfeeds-cap:   "Datafeeds"
-  ml-jobs:   "machine learning jobs"
-  ml-jobs-cap:   "Machine learning jobs"
-  anomaly-detect:   "anomaly detection"
-  anomaly-detect-cap:   "Anomaly detection"
-  anomaly-job:   "anomaly detection job"
-  anomaly-jobs:   "anomaly detection jobs"
-  anomaly-jobs-cap:   "Anomaly detection jobs"
-  dataframe:   "data frame"
-  dataframes:   "data frames"
-  dataframe-cap:   "Data frame"
-  dataframes-cap:   "Data frames"
-  watcher-transform:   "payload transform"
-  watcher-transforms:   "payload transforms"
-  watcher-transform-cap:   "Payload transform"
-  watcher-transforms-cap:   "Payload transforms"
-  transform:   "transform"
-  transforms:   "transforms"
-  transform-cap:   "Transform"
-  transforms-cap:   "Transforms"
-  dataframe-transform:   "transform"
-  dataframe-transform-cap:   "Transform"
-  dataframe-transforms:   "transforms"
-  dataframe-transforms-cap:   "Transforms"
-  dfanalytics-cap:   "Data frame analytics"
-  dfanalytics:   "data frame analytics"
-  dataframe-analytics-config:   "'{dataframe} analytics config'"
-  dfanalytics-job:   "'{dataframe} analytics job'"
-  dfanalytics-jobs:   "'{dataframe} analytics jobs'"
-  dfanalytics-jobs-cap:   "'{dataframe-cap} analytics jobs'"
-  cdataframe:   "continuous data frame"
-  cdataframes:   "continuous data frames"
-  cdataframe-cap:   "Continuous data frame"
-  cdataframes-cap:   "Continuous data frames"
-  cdataframe-transform:   "continuous transform"
-  cdataframe-transforms:   "continuous transforms"
-  cdataframe-transforms-cap:   "Continuous transforms"
-  ctransform:   "continuous transform"
-  ctransform-cap:   "Continuous transform"
-  ctransforms:   "continuous transforms"
-  ctransforms-cap:   "Continuous transforms"
-  oldetection:   "outlier detection"
-  oldetection-cap:   "Outlier detection"
-  olscore:   "outlier score"
-  olscores:   "outlier scores"
-  fiscore:   "feature influence score"
-  evaluatedf-api:   "evaluate {dataframe} analytics API"
-  evaluatedf-api-cap:   "Evaluate {dataframe} analytics API"
-  binarysc:   "binary soft classification"
-  binarysc-cap:   "Binary soft classification"
-  regression:   "regression"
-  regression-cap:   "Regression"
-  reganalysis:   "regression analysis"
-  reganalysis-cap:   "Regression analysis"
-  depvar:   "dependent variable"
-  feature-var:   "feature variable"
-  feature-vars:   "feature variables"
-  feature-vars-cap:   "Feature variables"
-  classification:   "classification"
-  classification-cap:   "Classification"
-  classanalysis:   "classification analysis"
-  classanalysis-cap:   "Classification analysis"
-  infer-cap:   "Inference"
-  infer:   "inference"
-  lang-ident-cap:   "Language identification"
-  lang-ident:   "language identification"
-  data-viz:   "Data Visualizer"
-  file-data-viz:   "File Data Visualizer"
-  feat-imp:   "feature importance"
-  feat-imp-cap:   "Feature importance"
-  nlp:   "natural language processing"
-  nlp-cap:   "Natural language processing"
-  apm-agent:   "APM agent"
-  apm-go-agent:   "Elastic APM Go agent"
-  apm-go-agents:   "Elastic APM Go agents"
-  apm-ios-agent:   "Elastic APM iOS agent"
-  apm-ios-agents:   "Elastic APM iOS agents"
-  apm-java-agent:   "Elastic APM Java agent"
-  apm-java-agents:   "Elastic APM Java agents"
-  apm-dotnet-agent:   "Elastic APM .NET agent"
-  apm-dotnet-agents:   "Elastic APM .NET agents"
-  apm-node-agent:   "Elastic APM Node.js agent"
-  apm-node-agents:   "Elastic APM Node.js agents"
-  apm-php-agent:   "Elastic APM PHP agent"
-  apm-php-agents:   "Elastic APM PHP agents"
-  apm-py-agent:   "Elastic APM Python agent"
-  apm-py-agents:   "Elastic APM Python agents"
-  apm-ruby-agent:   "Elastic APM Ruby agent"
-  apm-ruby-agents:   "Elastic APM Ruby agents"
-  apm-rum-agent:   "Elastic APM Real User Monitoring (RUM) JavaScript agent"
-  apm-rum-agents:   "Elastic APM RUM JavaScript agents"
-  apm-lambda-ext:   "Elastic APM AWS Lambda extension"
-  project-monitors:   "project monitors"
-  project-monitors-cap:   "Project monitors"
-  private-location:   "Private Location"
-  private-locations:   "Private Locations"
-  pwd:   "YOUR_PASSWORD"
-  esh:   "ES-Hadoop"
-  default-dist:   "default distribution"
-  oss-dist:   "OSS-only distribution"
-  observability:   "Observability"
-  api-request-title:   "Request"
-  api-prereq-title:   "Prerequisites"
-  api-description-title:   "Description"
-  api-path-parms-title:   "Path parameters"
-  api-query-parms-title:   "Query parameters"
-  api-request-body-title:   "Request body"
-  api-response-codes-title:   "Response codes"
-  api-response-body-title:   "Response body"
-  api-example-title:   "Example"
-  api-examples-title:   "Examples"
-  api-definitions-title:   "Properties"
-  multi-arg:   "†footnoteref:[multi-arg,This parameter accepts multiple arguments.]"
-  multi-arg-ref:   "†footnoteref:[multi-arg]"
-  yes-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15]"
-  no-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15]"
-  es-repo:   "https://github.com/elastic/elasticsearch/"
-  es-issue:   "https://github.com/elastic/elasticsearch/issues/"
-  es-pull:   "https://github.com/elastic/elasticsearch/pull/"
-  es-commit:   "https://github.com/elastic/elasticsearch/commit/"
-  kib-repo:   "https://github.com/elastic/kibana/"
-  kib-issue:   "https://github.com/elastic/kibana/issues/"
-  kibana-issue:   "'{kib-repo}issues/'"
-  kib-pull:   "https://github.com/elastic/kibana/pull/"
-  kibana-pull:   "'{kib-repo}pull/'"
-  kib-commit:   "https://github.com/elastic/kibana/commit/"
-  ml-repo:   "https://github.com/elastic/ml-cpp/"
-  ml-issue:   "https://github.com/elastic/ml-cpp/issues/"
-  ml-pull:   "https://github.com/elastic/ml-cpp/pull/"
-  ml-commit:   "https://github.com/elastic/ml-cpp/commit/"
-  apm-repo:   "https://github.com/elastic/apm-server/"
-  apm-issue:   "https://github.com/elastic/apm-server/issues/"
-  apm-pull:   "https://github.com/elastic/apm-server/pull/"
-  kibana-blob:   "https://github.com/elastic/kibana/blob/current/"
-  apm-get-started-ref:   "https://www.elastic.co/guide/en/apm/get-started/current"
-  apm-server-ref:   "https://www.elastic.co/guide/en/apm/server/current"
-  apm-server-ref-v:   "https://www.elastic.co/guide/en/apm/server/current"
-  apm-server-ref-m:   "https://www.elastic.co/guide/en/apm/server/master"
-  apm-server-ref-62:   "https://www.elastic.co/guide/en/apm/server/6.2"
-  apm-server-ref-64:   "https://www.elastic.co/guide/en/apm/server/6.4"
-  apm-server-ref-70:   "https://www.elastic.co/guide/en/apm/server/7.0"
-  apm-overview-ref-v:   "https://www.elastic.co/guide/en/apm/get-started/current"
-  apm-overview-ref-70:   "https://www.elastic.co/guide/en/apm/get-started/7.0"
-  apm-overview-ref-m:   "https://www.elastic.co/guide/en/apm/get-started/master"
-  infra-guide:   "https://www.elastic.co/guide/en/infrastructure/guide/current"
-  a-data-source:   "a data view"
-  icon-bug:   "pass:[<span class=\"eui-icon icon-bug\"></span>]"
-  icon-checkInCircleFilled:   "pass:[<span class=\"eui-icon icon-checkInCircleFilled\"></span>]"
-  icon-warningFilled:   "pass:[<span class=\"eui-icon icon-warningFilled\"></span>]"

docs/examples/proxy/api/autocomplete.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/api/delete.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/api/index.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/api/search.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/utils/authorize.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 // IMPORTANT: this is not a production ready code & purely for demonstration purposes,

docs/examples/proxy/utils/prepare-elasticsearch.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 'use strict'

docs/reference/basic-config.md

@@ -5,7 +5,7 @@ mapped_pages:
 
 # Basic configuration [basic-config]
 
-This page shows you the possible basic configuration options that the clients offers.
+This page explains the basic configuration options for the JavaScript client.
 
 ```js
 const { Client } = require('@elastic/elasticsearch')
@@ -18,34 +18,351 @@ const client = new Client({
 })
 ```
 
-|     |     |
-| --- | --- |
-| `node` or `nodes` | The Elasticsearch endpoint to use.<br> It can be a single string or an array of strings:<br><br>```js<br>node: 'http://localhost:9200'<br>```<br><br>Or it can be an object (or an array of objects) that represents the node:<br><br>```js<br>node: {<br>  url: new URL('http://localhost:9200'),<br>  tls: 'tls options',<br>  agent: 'http agent options',<br>  id: 'custom node id',<br>  headers: { 'custom': 'headers' }<br>  roles: {<br>    master: true,<br>    data: true,<br>    ingest: true,<br>    ml: false<br>  }<br>}<br>```<br> |
-| `auth` | Your authentication data. You can use both basic authentication and [ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).<br> See [Authentication](/reference/connecting.md#authentication) for more details.<br> *Default:* `null`<br><br>Basic authentication:<br><br>```js<br>auth: {<br>  username: 'elastic',<br>  password: 'changeme'<br>}<br>```<br><br>[ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) authentication:<br><br>```js<br>auth: {<br>  apiKey: 'base64EncodedKey'<br>}<br>```<br><br>Bearer authentication, useful for [service account tokens](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token). Be aware that it does not handle automatic token refresh:<br><br>```js<br>auth: {<br>  bearer: 'token'<br>}<br>```<br> |
-| `maxRetries` | `number` - Max number of retries for each request.<br>*Default:* `3` |
-| `requestTimeout` | `number` - Max request timeout in milliseconds for each request.<br>*Default:* No value |
-| `pingTimeout` | `number` - Max ping request timeout in milliseconds for each request.<br>*Default:* `3000` |
-| `sniffInterval` | `number, boolean` - Perform a sniff operation every `n` milliseconds. Sniffing might not be the best solution for you, take a look [here](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how) to know more.<br>*Default:* `false` |
-| `sniffOnStart` | `boolean` - Perform a sniff once the client is started. Sniffing might not be the best solution for you, take a look [here](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how) to know more.<br>*Default:* `false` |
-| `sniffEndpoint` | `string` - Endpoint to ping during a sniff.<br>*Default:* `'_nodes/_all/http'` |
-| `sniffOnConnectionFault` | `boolean` - Perform a sniff on connection fault. Sniffing might not be the best solution for you, take a look [here](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how) to know more.<br>*Default:* `false` |
-| `resurrectStrategy` | `string` - Configure the node resurrection strategy.<br>*Options:* `'ping'`, `'optimistic'`, `'none'`<br>*Default:* `'ping'` |
-| `suggestCompression` | `boolean` - Adds `accept-encoding` header to every request.<br>*Default:* `false` |
-| `compression` | `string, boolean` - Enables gzip request body compression.<br>*Options:* `'gzip'`, `false`<br>*Default:* `false` |
-| `tls` | `http.SecureContextOptions` - tls [configuraton](https://nodejs.org/api/tls.md).<br>*Default:* `null` |
-| `proxy` | `string, URL` - If you are using an http(s) proxy, you can put its url here. The client will automatically handle the connection to it.<br> *Default:* `null`<br><br>```js<br>const client = new Client({<br>  node: 'http://localhost:9200',<br>  proxy: 'http://localhost:8080'<br>})<br><br>const client = new Client({<br>  node: 'http://localhost:9200',<br>  proxy: 'http://user:pwd@localhost:8080'<br>})<br>```<br> |
-| `agent` | `http.AgentOptions, function` - http agent [options](https://nodejs.org/api/http.md#http_new_agent_options), or a function that returns an actual http agent instance. If you want to disable the http agent use entirely (and disable the `keep-alive` feature), set the agent to `false`.<br> *Default:* `null`<br><br>```js<br>const client = new Client({<br>  node: 'http://localhost:9200',<br>  agent: { agent: 'options' }<br>})<br><br>const client = new Client({<br>  node: 'http://localhost:9200',<br>  // the function takes as parameter the option<br>  // object passed to the Connection constructor<br>  agent: (opts) => new CustomAgent()<br>})<br><br>const client = new Client({<br>  node: 'http://localhost:9200',<br>  // Disable agent and keep-alive<br>  agent: false<br>})<br>```<br> |
-| `nodeFilter` | `function` - Filters which node not to use for a request.<br> *Default:*<br><br>```js<br>function defaultNodeFilter (node) {<br>  // avoid master only nodes<br>  if (node.roles.master === true &&<br>      node.roles.data === false &&<br>      node.roles.ingest === false) {<br>    return false<br>  }<br>  return true<br>}<br>```<br> |
-| `nodeSelector` | `function` - custom selection strategy.<br> *Options:* `'round-robin'`, `'random'`, custom function<br> *Default:* `'round-robin'`<br> *Custom function example:*<br><br>```js<br>function nodeSelector (connections) {<br>  const index = calculateIndex()<br>  return connections[index]<br>}<br>```<br> |
-| `generateRequestId` | `function` - function to generate the request id for every request, it takes two parameters, the request parameters and options.<br> By default it generates an incremental integer for every request.<br> *Custom function example:*<br><br>```js<br>function generateRequestId (params, options) {<br>  // your id generation logic<br>  // must be syncronous<br>  return 'id'<br>}<br>```<br> |
-| `name` | `string, symbol` - The name to identify the client instance in the events.<br>*Default:* `elasticsearch-js` |
-| `opaqueIdPrefix` | `string` - A string that will be use to prefix any `X-Opaque-Id` header.<br>See [`X-Opaque-Id` support](/reference/observability.md#_x_opaque_id_support) for more details.<br>_Default:* `null` |
-| `headers` | `object` - A set of custom headers to send in every request.<br>*Default:* `{}` |
-| `context` | `object` - A custom object that you can use for observability in your events.It will be merged with the API level context option.<br>*Default:* `null` |
-| `enableMetaHeader` | `boolean` - If true, adds an header named `'x-elastic-client-meta'`, containing some minimal telemetry data,such as the client and platform version.<br>*Default:* `true` |
-| `cloud` | `object` - Custom configuration for connecting to [Elastic Cloud](https://cloud.elastic.co). See [Authentication](/reference/connecting.md) for more details.<br> *Default:* `null`<br> *Cloud configuration example:*<br><br>```js<br>const client = new Client({<br>  cloud: {<br>    id: '<cloud-id>'<br>  },<br>  auth: {<br>    username: 'elastic',<br>    password: 'changeme'<br>  }<br>})<br>```<br> |
-| `disablePrototypePoisoningProtection` | `boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. Read [this article](https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08) to learn more about this security concern. If needed, you can enable prototype poisoning protection entirely (`false`) or one of the two checks (`'proto'` or `'constructor'`). For performance reasons, it is disabled by default. Read the `secure-json-parse` [documentation](https://github.com/fastify/secure-json-parse) to learn more.<br>*Default:* `true` |
-| `caFingerprint` | `string` - If configured, verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint. Only accepts SHA256 digest fingerprints.<br>*Default:* `null` |
-| `maxResponseSize` | `number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENGTH<br>*Default:* `null` |
-| `maxCompressedResponseSize` | `number` - When configured, it verifies that the compressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENGTH<br>*Default:* `null` |
+### `node` or `nodes`
 
+The {{es}} endpoint to use. It can be a single string or an array of strings:
+
+```js
+node: 'http://localhost:9200'
+```
+
+```js
+nodes: ['http://localhost:9200', 'http://localhost:9201']
+```
+
+Or it can be an object (or an array of objects) that represents the node:
+
+```js
+node: {
+  url: new URL('http://localhost:9200'),
+  tls: 'tls options',
+  agent: 'http agent options',
+  id: 'custom node id',
+  headers: { 'custom': 'headers' },
+  roles: {
+    master: true,
+    data: true,
+    ingest: true,
+    ml: false
+  }
+}
+```
+
+---
+
+### `auth`
+
+Default: `null`
+
+Your authentication data. You can use both basic authentication and [ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).
+ See [Authentication](/reference/connecting.md#authentication) for more details.
+
+Basic authentication:
+
+```js
+auth: {
+  username: 'elastic',
+  password: 'changeme'
+}
+```
+
+[ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) authentication:
+
+```js
+auth: {
+  apiKey: 'base64EncodedKey'
+}
+```
+
+Bearer authentication, useful for [service account tokens](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token). Be aware that it does not handle automatic token refresh:
+
+```js
+auth: {
+  bearer: 'token'
+}
+```
+
+### `maxRetries`
+
+Type: `number`<br>
+Default: `3`
+
+Max number of retries for each request.
+
+### `requestTimeout`
+
+Type: `number`<br>
+Default: `No value`
+
+Max request timeout in milliseconds for each request.
+
+### `pingTimeout`
+
+Type: `number`<br>
+Default: `3000`
+
+Max ping request timeout in milliseconds for each request.
+
+### `sniffInterval`
+
+Type: `number, boolean`<br>
+Default: `false`
+
+Perform a sniff operation every `n` milliseconds.
+
+:::{tip}
+Sniffing might not be the best solution. Before using the various `sniff` options, review this [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+:::
+
+### `sniffOnStart`
+
+Type: `boolean`<br>
+Default: `false`
+
+Perform a sniff once the client is started. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+
+### `sniffEndpoint`
+
+Type: `string`<br>
+Default: `'_nodes/_all/http'`
+
+Endpoint to ping during a sniff. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+
+### `sniffOnConnectionFault`
+
+Type: `boolean`<br>
+Default: `false`
+
+Perform a sniff on connection fault. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
+
+### `resurrectStrategy`
+
+Type: `string`<br>
+Default: `'ping'`
+
+Configure the node resurrection strategy.<br>
+Options: `'ping'`, `'optimistic'`, `'none'`
+
+### `suggestCompression`
+
+Type: `boolean`<br>
+Default: `false`
+
+Adds an `accept-encoding` header to every request.
+
+### `compression`
+
+Type: `string, boolean`<br>
+Default: `false`
+
+Enables gzip request body compression.<br>
+Options: `'gzip'`, `false`
+
+### `tls`
+
+Type: `http.SecureContextOptions`<br>
+Default: `null`
+
+The [tls configuraton](https://nodejs.org/api/tls.html).
+
+### `proxy`
+
+Type: `string, URL`<br>
+Default: `null`
+
+If you are using an http(s) proxy, you can put its url here. The client will automatically handle the connection to it.
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://localhost:8080'
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://user:pwd@localhost:8080'
+})
+```
+
+### `agent`
+
+Type: `http.AgentOptions, function`<br>
+Default: `null`
+
+http agent [options](https://nodejs.org/api/http.html#http_new_agent_options), or a function that returns an actual http agent instance. If you want to disable the http agent use entirely (and disable the `keep-alive` feature), set the agent to `false`.
+
+```js
+const client = new Client({
+  node: 'http://localhost:9200',
+  agent: { agent: 'options' }
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  // the function takes as parameter the option
+  // object passed to the Connection constructor
+  agent: (opts) => new CustomAgent()
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  // Disable agent and keep-alive
+  agent: false
+})
+```
+
+### `nodeFilter`
+
+Type: `function`
+
+Filter that indicates whether a node should be used for a request. Default function definition:
+
+```js
+function defaultNodeFilter (conn) {
+  if (conn.roles != null) {
+    if (
+      // avoid master-only nodes
+      conn.roles.master &&
+      !conn.roles.data &&
+      !conn.roles.ingest &&
+      !conn.roles.ml
+    ) return false
+  }
+  return true
+}
+```
+
+### `nodeSelector`
+
+Type: `function`<br>
+Default: `'round-robin'`
+
+Custom selection strategy.<br>
+Options: `'round-robin'`, `'random'`, custom function
+
+Custom function example:
+
+```js
+function nodeSelector (connections) {
+  const index = calculateIndex()
+  return connections[index]
+}
+```
+
+### `generateRequestId`
+
+Type: `function`<br>
+
+function to generate the request id for every request, it takes two parameters, the request parameters and options. By default, it generates an incremental integer for every request.
+
+Custom function example:
+
+```js
+function generateRequestId (params, options) {
+  // your id generation logic
+  // must be syncronous
+  return 'id'
+}
+```
+
+### `name`
+
+Type: `string, symbol`<br>
+Default: `elasticsearch-js`
+
+The name to identify the client instance in the events.
+
+### `opaqueIdPrefix`
+
+Type: `string`<br>
+Default: `null`
+
+A string that will be use to prefix any `X-Opaque-Id` header.
+See [`X-Opaque-Id` support](/reference/observability.md#_x_opaque_id_support) for more details.
+
+### `headers`
+
+Type: `object`<br>
+Default: `{}`
+
+A set of custom headers to send in every request.
+
+### `context`
+
+Type: `object`<br>
+Default: `null`
+
+A custom object that you can use for observability in your events. It will be merged with the API level context option.
+
+### `enableMetaHeader`
+
+Type: `boolean`<br>
+Default: `true`
+
+If true, adds an header named `'x-elastic-client-meta'`, containing some minimal telemetry data, such as the client and platform version.
+
+### `cloud`
+
+Type: `object`<br>
+Default: `null`
+
+Custom configuration for connecting to [Elastic Cloud](https://cloud.elastic.co). See [Authentication](/reference/connecting.md) for more details.
+
+Cloud configuration example:
+
+```js
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+```
+
+### `disablePrototypePoisoningProtection`
+
+Default: `true`
+
+`boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. For more information, refer to [Square Brackets are the Enemy](https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08). If needed, you can enable prototype poisoning protection entirely (`false`) or one of the two checks (`'proto'` or `'constructor'`). For performance reasons, it is disabled by default. To learn more, refer to the [`secure-json-parse` documentation](https://github.com/fastify/secure-json-parse).
+
+### `caFingerprint`
+
+Type: `string`<br>
+Default: `null`
+
+If configured, verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint. Only accepts SHA256 digest fingerprints.
+
+### `maxResponseSize`
+
+Type: `number`<br>
+Default: `null`
+
+When configured, `maxResponseSize` verifies that the uncompressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.
+
+### `maxCompressedResponseSize`
+
+Type: `number`<br>
+Default: `null`
+
+When configured, `maxCompressedResponseSize` verifies that the compressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxCompressedResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.
+
+### `redaction`
+
+Type: `object`<br>
+Default: A configuration that will replace known sources of sensitive data in `Error` metadata
+
+Options for how to redact potentially sensitive data from metadata attached to `Error` objects
+
+::::{note}
+[Read about redaction](/reference/advanced-config.md#redaction) for more details
+::::
+
+### `serverMode`
+
+Type: `string`<br>
+Default: `"stack"`
+
+Setting to `"stack"` sets defaults assuming a traditional (non-serverless) {{es}} instance. Setting to `"serverless"` sets defaults to work more seamlessly with [Elastic Cloud Serverless](https://www.elastic.co/guide/en/serverless/current/intro.html), like enabling compression and disabling features that assume the possibility of multiple {{es}} nodes.

docs/reference/client-helpers.md

@@ -11,15 +11,12 @@ The client comes with an handy collection of helpers to give you a more comforta
 The client helpers are experimental, and the API may change in the next minor releases. The helpers will not work in any Node.js version lower than 10.
 ::::
 
-
-
 ## Bulk helper [bulk-helper]
 
 Added in `v7.7.0`
 
 Running bulk requests can be complex due to the shape of the API, this helper aims to provide a nicer developer experience around the Bulk API.
 
-
 ### Usage [_usage_3]
 
 ```js
@@ -54,23 +51,122 @@ console.log(result)
 
 To create a new instance of the Bulk helper, access it as shown in the example above, the configuration options are:
 
-|     |     |
-| --- | --- |
-| `datasource` | An array, async generator or a readable stream with the data you need to index/create/update/delete. It can be an array of strings or objects, but also a stream of json strings or JavaScript objects.<br> If it is a stream, we recommend to use the [`split2`](https://www.npmjs.com/package/split2) package, that splits the stream on new lines delimiters.<br> This parameter is mandatory.<br><br>```js<br>const { createReadStream } = require('fs')<br>const split = require('split2')<br>const b = client.helpers.bulk({<br>  // if you just use split(), the data will be used as array of strings<br>  datasource: createReadStream('./dataset.ndjson').pipe(split())<br>  // if you need to manipulate the data, you can pass JSON.parse to split<br>  datasource: createReadStream('./dataset.ndjson').pipe(split(JSON.parse))<br>})<br>```<br> |
-| `onDocument` | A function that is called for each document of the datasource. Inside this function you can manipulate the document and you must return the operation you want to execute with the document. Look at the [Bulk API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk) to see the supported operations.<br> This parameter is mandatory.<br><br>```js<br>const b = client.helpers.bulk({<br>  onDocument (doc) {<br>    return {<br>      index: { _index: 'my-index' }<br>    }<br>  }<br>})<br>```<br> |
-| `onDrop` | A function that is called for everytime a document can’t be indexed and it has reached the maximum amount of retries.<br><br>```js<br>const b = client.helpers.bulk({<br>  onDrop (doc) {<br>    console.log(doc)<br>  }<br>})<br>```<br> |
-| `onSuccess` | A function that is called for each successful operation in the bulk request, which includes the result from Elasticsearch along with the original document that was sent, or `null` for delete operations.<br><br>```js<br>const b = client.helpers.bulk({<br>  onSuccess ({ result, document }) {<br>    console.log(`SUCCESS: Document ${result.index._id} indexed to ${result.index._index}`)<br>  }<br>})<br>```<br> |
-| `flushBytes` | The size of the bulk body in bytes to reach before to send it. Default of 5MB.<br> *Default:* `5000000`<br><br>```js<br>const b = client.helpers.bulk({<br>  flushBytes: 1000000<br>})<br>```<br> |
-| `flushInterval` | How much time (in milliseconds) the helper waits before flushing the body from the last document read.<br> *Default:* `30000`<br><br>```js<br>const b = client.helpers.bulk({<br>  flushInterval: 30000<br>})<br>```<br> |
-| `concurrency` | How many request is executed at the same time.<br> *Default:* `5`<br><br>```js<br>const b = client.helpers.bulk({<br>  concurrency: 10<br>})<br>```<br> |
-| `retries` | How many times a document is retried before to call the `onDrop` callback.<br> *Default:* Client max retries.<br><br>```js<br>const b = client.helpers.bulk({<br>  retries: 3<br>})<br>```<br> |
-| `wait` | How much time to wait before retries in milliseconds.<br> *Default:* 5000.<br><br>```js<br>const b = client.helpers.bulk({<br>  wait: 3000<br>})<br>```<br> |
-| `refreshOnCompletion` | If `true`, at the end of the bulk operation it runs a refresh on all indices or on the specified indices.<br> *Default:* false.<br><br>```js<br>const b = client.helpers.bulk({<br>  refreshOnCompletion: true<br>  // or<br>  refreshOnCompletion: 'index-name'<br>})<br>```<br> |
+`datasource`
+:   An array, async generator or a readable stream with the data you need to index/create/update/delete. It can be an array of strings or objects, but also a stream of json strings or JavaScript objects.
+    If it is a stream, we recommend to use the [`split2`](https://www.npmjs.com/package/split2) package, that splits the stream on new lines delimiters.
+    This parameter is mandatory.
 
+    ```js
+    const { createReadStream } = require('fs')
+    const split = require('split2')
+    const b = client.helpers.bulk({
+      // if you just use split(), the data will be used as array of strings
+      datasource: createReadStream('./dataset.ndjson').pipe(split())
+      // if you need to manipulate the data, you can pass JSON.parse to split
+      datasource: createReadStream('./dataset.ndjson').pipe(split(JSON.parse))
+    })
+    ```
+
+`onDocument`
+:   A function that is called for each document of the datasource. Inside this function you can manipulate the document and you must return the operation you want to execute with the document. Look at the [Bulk API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk) to see the supported operations.
+    This parameter is mandatory.
+
+    ```js
+    const b = client.helpers.bulk({
+      onDocument (doc) {
+        return {
+          index: { _index: 'my-index' }
+        }
+      }
+    })
+    ```
+
+`onDrop`
+:   A function that is called for everytime a document can’t be indexed and it has reached the maximum amount of retries.
+
+    ```js
+    const b = client.helpers.bulk({
+      onDrop (doc) {
+        console.log(doc)
+      }
+    })
+    ```
+
+`onSuccess`
+:   A function that is called for each successful operation in the bulk request, which includes the result from Elasticsearch along with the original document that was sent, or `null` for delete operations.
+
+    ```js
+    const b = client.helpers.bulk({
+      onSuccess ({ result, document }) {
+        console.log(`SUCCESS: Document ${result.index._id} indexed to ${result.index._index}`)
+      }
+    })
+    ```
+
+`flushBytes`
+:   The size of the bulk body in bytes to reach before to send it. Default of 5MB.
+    *Default:* `5000000`
+
+    ```js
+    const b = client.helpers.bulk({
+      flushBytes: 1000000
+    })
+    ```
+
+`flushInterval`
+:   How much time (in milliseconds) the helper waits before flushing the body from the last document read.
+    *Default:* `30000`
+
+    ```js
+    const b = client.helpers.bulk({
+      flushInterval: 30000
+    })
+    ```
+
+`concurrency`
+:   How many request is executed at the same time.
+    *Default:* `5`
+
+    ```js
+    const b = client.helpers.bulk({
+      concurrency: 10
+    })
+    ```
+
+`retries`
+:   How many times a document is retried before to call the `onDrop` callback.
+    *Default:* Client max retries.
+
+    ```js
+    const b = client.helpers.bulk({
+      retries: 3
+    })
+    ```
+
+`wait`
+:   How much time to wait before retries in milliseconds.
+    *Default:* 5000.
+
+    ```js
+    const b = client.helpers.bulk({
+      wait: 3000
+    })
+    ```
+
+`refreshOnCompletion`
+:   If `true`, at the end of the bulk operation it runs a refresh on all indices or on the specified indices.
+    *Default:* false.
+
+    ```js
+    const b = client.helpers.bulk({
+      refreshOnCompletion: true
+      // or
+      refreshOnCompletion: 'index-name'
+    })
+    ```
 
 ### Supported operations [_supported_operations]
 
-
 #### Index [_index_2]
 
 ```js
@@ -84,7 +180,6 @@ client.helpers.bulk({
 })
 ```
 
-
 #### Create [_create_4]
 
 ```js
@@ -98,7 +193,6 @@ client.helpers.bulk({
 })
 ```
 
-
 #### Update [_update_3]
 
 ```js
@@ -116,7 +210,6 @@ client.helpers.bulk({
 })
 ```
 
-
 #### Delete [_delete_10]
 
 ```js
@@ -130,7 +223,6 @@ client.helpers.bulk({
 })
 ```
 
-
 ### Abort a bulk operation [_abort_a_bulk_operation]
 
 If needed, you can abort a bulk operation at any time. The bulk helper returns a [thenable](https://promisesaplus.com/), which has an `abort` method.
@@ -139,7 +231,6 @@ If needed, you can abort a bulk operation at any time. The bulk helper returns a
 The abort method stops the execution of the bulk operation, but if you are using a concurrency higher than one, the operations that are already running will not be stopped.
 ::::
 
-
 ```js
 const { createReadStream } = require('fs')
 const split = require('split2')
@@ -164,7 +255,6 @@ const b = client.helpers.bulk({
 console.log(await b)
 ```
 
-
 ### Passing custom options to the Bulk API [_passing_custom_options_to_the_bulk_api]
 
 You can pass any option supported by the link: [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk) to the helper, and the helper uses those options in conjunction with the Bulk API call.
@@ -181,7 +271,6 @@ const result = await client.helpers.bulk({
 })
 ```
 
-
 ### Usage with an async generator [_usage_with_an_async_generator]
 
 ```js
@@ -214,7 +303,6 @@ const result = await client.helpers.bulk({
 console.log(result)
 ```
 
-
 ### Modifying a document before operation [_modifying_a_document_before_operation]
 
 Added in `v8.8.2`
@@ -241,14 +329,12 @@ const result = await client.helpers.bulk({
 console.log(result)
 ```
 
-
 ## Multi search helper [multi-search-helper]
 
 Added in `v7.8.0`
 
 If you send search request at a high rate, this helper might be useful for you. It uses the multi search API under the hood to batch the requests and improve the overall performances of your application. The `result` exposes a `documents` property as well, which allows you to access directly the hits sources.
 
-
 ### Usage [_usage_4]
 
 ```js
@@ -270,14 +356,55 @@ m.search(
 
 To create a new instance of the multi search (msearch) helper, you should access it as shown in the example above, the configuration options are:
 
-|     |     |
-| --- | --- |
-| `operations` | How many search operations should be sent in a single msearch request.<br> *Default:* `5`<br><br>```js<br>const m = client.helpers.msearch({<br>  operations: 10<br>})<br>```<br> |
-| `flushInterval` | How much time (in milliseconds) the helper waits before flushing the operations from the last operation read.<br> *Default:* `500`<br><br>```js<br>const m = client.helpers.msearch({<br>  flushInterval: 500<br>})<br>```<br> |
-| `concurrency` | How many request is executed at the same time.<br> *Default:* `5`<br><br>```js<br>const m = client.helpers.msearch({<br>  concurrency: 10<br>})<br>```<br> |
-| `retries` | How many times an operation is retried before to resolve the request. An operation is retried only in case of a 429 error.<br> *Default:* Client max retries.<br><br>```js<br>const m = client.helpers.msearch({<br>  retries: 3<br>})<br>```<br> |
-| `wait` | How much time to wait before retries in milliseconds.<br> *Default:* 5000.<br><br>```js<br>const m = client.helpers.msearch({<br>  wait: 3000<br>})<br>```<br> |
+`operations`
+:   How many search operations should be sent in a single msearch request.
+    *Default:* `5`
 
+    ```js
+    const m = client.helpers.msearch({
+      operations: 10
+    })
+    ```
+
+`flushInterval`
+:   How much time (in milliseconds) the helper waits before flushing the operations from the last operation read.
+    *Default:* `500`
+
+    ```js
+    const m = client.helpers.msearch({
+      flushInterval: 500
+    })
+    ```
+
+`concurrency`
+:   How many request is executed at the same time.
+    *Default:* `5`
+
+    ```js
+    const m = client.helpers.msearch({
+      concurrency: 10
+    })
+    ```
+
+`retries`
+:   How many times an operation is retried before to resolve the request. An operation is retried only in case of a 429 error.
+    *Default:* Client max retries.
+
+    ```js
+    const m = client.helpers.msearch({
+      retries: 3
+    })
+    ```
+
+`wait`
+:   How much time to wait before retries in milliseconds.
+    *Default:* 5000.
+
+    ```js
+    const m = client.helpers.msearch({
+      wait: 3000
+    })
+    ```
 
 ### Stopping the msearch helper [_stopping_the_msearch_helper]
 
@@ -291,7 +418,6 @@ The `stop` method accepts an optional error, that will be dispatched every subse
 The stop method stops the execution of the msearch processor, but if you are using a concurrency higher than one, the operations that are already running will not be stopped.
 ::::
 
-
 ```js
 const { Client } = require('@elastic/elasticsearch')
 
@@ -318,7 +444,6 @@ m.search(
 setImmediate(() => m.stop())
 ```
 
-
 ## Search helper [search-helper]
 
 Added in `v7.7.0`
@@ -340,7 +465,6 @@ for (const doc of documents) {
 }
 ```
 
-
 ## Scroll search helper [scroll-search-helper]
 
 Added in `v7.7.0`
@@ -362,7 +486,6 @@ for await (const result of scrollSearch) {
 }
 ```
 
-
 ### Clear a scroll search [_clear_a_scroll_search]
 
 If needed, you can clear a scroll search by calling `result.clear()`:
@@ -375,7 +498,6 @@ for await (const result of scrollSearch) {
 }
 ```
 
-
 ### Quickly getting the documents [_quickly_getting_the_documents]
 
 If you only need the documents from the result of a scroll search, you can access them via `result.documents`:
@@ -386,7 +508,6 @@ for await (const result of scrollSearch) {
 }
 ```
 
-
 ## Scroll documents helper [scroll-documents-helper]
 
 Added in `v7.7.0`
@@ -408,15 +529,12 @@ for await (const doc of scrollSearch) {
 }
 ```
 
-
 ## ES|QL helper [esql-helper]
 
 ES|QL queries can return their results in [several formats](docs-content://explore-analyze/query-filter/languages/esql-rest.md#esql-rest-format). The default JSON format returned by ES|QL queries contains arrays of values for each row, with column names and types returned separately:
 
-
 ### Usage [_usage_5]
 
-
 #### `toRecords` [_torecords]
 
 Added in `v8.14.0`
@@ -494,14 +612,13 @@ const result = await client.helpers
   .toRecords<EventLog>()
 ```
 
-
 #### `toArrowReader` [_toarrowreader]
 
 Added in `v8.16.0`
 
 ES|QL can return results in multiple binary formats, including [Apache Arrow](https://arrow.apache.org/)'s streaming format. Because it is a very efficient format to read, it can be valuable for performing high-performance in-memory analytics. And, because the response is streamed as batches of records, it can be used to produce aggregations and other calculations on larger-than-memory data sets.
 
-`toArrowReader` returns a [`RecordBatchStreamReader`](https://arrow.apache.org/docs/js/classes/Arrow_dom.RecordBatchReader.md).
+`toArrowReader` returns an [`AsyncRecordBatchStreamReader`](https://github.com/apache/arrow/blob/520ae44272d491bbb52eb3c9b84864ed7088f11a/js/src/ipc/reader.ts#L216).
 
 ```ts
 const reader = await client.helpers
@@ -509,14 +626,13 @@ const reader = await client.helpers
   .toArrowReader()
 
 // print each record as JSON
-for (const recordBatch of reader) {
+for await (const recordBatch of reader) {
   for (const record of recordBatch) {
     console.log(record.toJSON())
   }
 }
 ```
 
-
 #### `toArrowTable` [_toarrowtable]
 
 Added in `v8.16.0`

docs/reference/configuration.md

@@ -7,13 +7,8 @@ mapped_pages:
 
 The client is designed to be easily configured for your needs. In the following section, you can see the possible options that you can use to configure it.
 
-* [Basic configuration](/reference/basic-config.md)
-* [Advanced configuration](/reference/advanced-config.md)
-* [Timeout best practices](docs-content://troubleshoot/elasticsearch/elasticsearch-client-javascript-api/nodejs.md)
-* [Creating a child client](/reference/child.md)
-* [Testing](/reference/client-testing.md)
-
-
-
-
-
+- [Basic configuration](/reference/basic-config.md)
+- [Advanced configuration](/reference/advanced-config.md)
+- [Timeout best practices](/reference/timeout-best-practices.md)
+- [Creating a child client](/reference/child.md)
+- [Testing](/reference/client-testing.md)

docs/reference/connecting.md

@@ -11,7 +11,6 @@ This page contains the information you need to connect and use the Client with {
 
 This document contains code snippets to show you how to connect to various {{es}} providers.
 
-
 ### Elastic Cloud [auth-ec]
 
 If you are using [Elastic Cloud](https://www.elastic.co/cloud), the client offers an easy way to connect to it via the `cloud` option. You must pass the Cloud ID that you can find in the cloud console, then your username and password inside the `auth` option.
@@ -20,12 +19,10 @@ If you are using [Elastic Cloud](https://www.elastic.co/cloud), the client offer
 When connecting to Elastic Cloud, the client will automatically enable both request and response compression by default, since it yields significant throughput improvements. Moreover, the client will also set the tls option `secureProtocol` to `TLSv1_2_method` unless specified otherwise. You can still override this option by configuring them.
 ::::
 
-
 ::::{important}
 Do not enable sniffing when using Elastic Cloud, since the nodes are behind a load balancer, Elastic Cloud will take care of everything for you. Take a look [here](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how) to know more.
 ::::
 
-
 ```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
@@ -39,6 +36,24 @@ const client = new Client({
 })
 ```
 
+## Connecting to an Elastic Cloud Serverless instance [connect-serverless]
+
+The Node.js client is built to support connecting to [Elastic Cloud Serverless](https://www.elastic.co/guide/en/serverless/current/intro.html). By setting the `serverMode` option to `"serverless"`, several default options will be modified to better suit the serverless environment.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  },
+  serverMode: 'serverless'
+})
+
+```
 
 ## Connecting to a self-managed cluster [connect-self-managed-new]
 
@@ -62,7 +77,6 @@ When you start {{es}} for the first time you’ll see a distinct block like the
 
 Depending on the circumstances there are two options for verifying the HTTPS connection, either verifying with the CA certificate itself or via the HTTP CA certificate fingerprint.
 
-
 ### TLS configuration [auth-tls]
 
 The generated root CA certificate can be found in the `certs` directory in your {{es}} config location (`$ES_CONF_PATH/certs/http_ca.crt`). If you’re running {{es}} in Docker there is [additional documentation for retrieving the CA certificate](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-docker.md).
@@ -84,7 +98,6 @@ const client = new Client({
 })
 ```
 
-
 ### CA fingerprint [auth-ca-fingerprint]
 
 You can configure the client to only trust certificates that are signed by a specific CA certificate (CA certificate pinning) by providing a `caFingerprint` option. This will verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied value. You must configure a SHA256 digest.
@@ -125,14 +138,12 @@ The output of `openssl x509` will look something like this:
 SHA256 Fingerprint=A5:2D:D9:35:11:E8:C6:04:5E:21:F1:66:54:B7:7C:9E:E0:F3:4A:EA:26:D9:F4:03:20:B5:31:C4:74:67:62:28
 ```
 
-
 ## Connecting without security enabled [connect-no-security]
 
 ::::{warning}
 Running {{es}} without security enabled is not recommended.
 ::::
 
-
 If your cluster is configured with [security explicitly disabled](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md) then you can connect via HTTP:
 
 ```js
@@ -142,12 +153,10 @@ const client = new Client({
 })
 ```
 
-
 ## Authentication strategies [auth-strategies]
 
 Following you can find all the supported authentication strategies.
 
-
 ### ApiKey authentication [auth-apikey]
 
 You can use the [ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) authentication by passing the `apiKey` parameter via the `auth` option. The `apiKey` parameter can be either a base64 encoded string or an object with the values that you can obtain from the [create api key endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).
@@ -156,7 +165,6 @@ You can use the [ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/opera
 If you provide both basic authentication credentials and the ApiKey configuration, the ApiKey takes precedence.
 ::::
 
-
 ```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
@@ -180,7 +188,6 @@ const client = new Client({
 })
 ```
 
-
 ### Bearer authentication [auth-bearer]
 
 You can provide your credentials by passing the `bearer` token parameter via the `auth` option. Useful for [service account tokens](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token). Be aware that it does not handle automatic token refresh.
@@ -195,7 +202,6 @@ const client = new Client({
 })
 ```
 
-
 ### Basic authentication [auth-basic]
 
 You can provide your credentials by passing the `username` and `password` parameters via the `auth` option.
@@ -204,7 +210,6 @@ You can provide your credentials by passing the `username` and `password` parame
 If you provide both basic authentication credentials and the Api Key configuration, the Api Key will take precedence.
 ::::
 
-
 ```js
 const { Client } = require('@elastic/elasticsearch')
 const client = new Client({
@@ -225,7 +230,6 @@ const client = new Client({
 })
 ```
 
-
 ## Usage [client-usage]
 
 Using the client is straightforward, it supports all the public APIs of {{es}}, and every method exposes the same signature.
@@ -278,8 +282,6 @@ In this case, the result will be:
 The body is a boolean value when you use `HEAD` APIs.
 ::::
 
-
-
 ### Aborting a request [_aborting_a_request]
 
 If needed, you can abort a running request by using the `AbortController` standard.
@@ -288,7 +290,6 @@ If needed, you can abort a running request by using the `AbortController` standa
 If you abort a request, the request will fail with a `RequestAbortedError`.
 ::::
 
-
 ```js
 const AbortController = require('node-abort-controller')
 const { Client } = require('@elastic/elasticsearch')
@@ -308,7 +309,6 @@ const result = await client.search({
 }, { signal: abortController.signal })
 ```
 
-
 ### Request specific options [_request_specific_options]
 
 If needed you can pass request specific options in a second object:
@@ -332,27 +332,27 @@ The supported request specific options are:
 | Option | Description |
 | --- | ----------- |
 | `ignore` | `number[]` -  HTTP status codes which should not be considered errors for this request.<br>*Default:* `null` |
-| `requestTimeout` | `number` or `string` - Max request timeout for the request in milliseconds. This overrides the client default, which is to not time out at all. See [Elasticsearch best practices for HTML clients](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more info.<br>_Default:* No timeout |
+| `requestTimeout` | `number` or `string` - Max request timeout for the request in milliseconds. This overrides the client default, which is to not time out at all. See [Elasticsearch best practices for HTML clients](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more info.<br>_Default:_ No timeout |
 | `retryOnTimeout` | `boolean` - Retry requests that have timed out.*Default:* `false` |
 | `maxRetries` | `number` - Max number of retries for the request, it overrides the client default.<br>*Default:* `3` |
 | `compression` | `string` or  `boolean` - Enables body compression for the request.<br>*Options:* `false`, `'gzip'`<br>*Default:* `false` |
 | `asStream` | `boolean` - Instead of getting the parsed body back, you get the raw Node.js stream of data.<br>*Default:* `false` |
 | `headers` | `object` - Custom headers for the request.<br>*Default:* `null` |
-|`querystring` | `object` - Custom querystring for the request.<br>*Default:* `null` |
+| `querystring` | `object` - Custom querystring for the request.<br>*Default:* `null` |
 | `id` | `any` - Custom request ID. *(overrides the top level request id generator)*<br>*Default:* `null` |
 | `context` | `any` - Custom object per request. *(you can use it to pass data to the clients events)*<br>*Default:* `null` |
-| `opaqueId` | `string` - Set the `X-Opaque-Id` HTTP header. See [X-Opaque-Id HTTP header](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#x-opaque-id) *Default:* `null` |
+| `opaqueId` | `string` - Set the `X-Opaque-Id` HTTP header. See [X-Opaque-Id HTTP header](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#x-opaque-id)<br>*Default:* `null` |
 | `maxResponseSize` | `number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENTGH<br>*Default:* `null` |
 | `maxCompressedResponseSize` | `number` - When configured, it verifies that the compressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENTGH<br>*Default:* `null` |
 | `signal` | `AbortSignal` - The AbortSignal instance to allow request abortion.<br>*Default:* `null` |
 | `meta` | `boolean` - Rather than returning the body, return an object containing `body`, `statusCode`, `headers` and `meta` keys<br>*Default*: `false` |
-| `redaction` | `object` - Options for redacting potentially sensitive data from error metadata. See [Redaction of potentially sensitive data](/reference/advanced-config.md#redaction). | `retryBackoff` |
+| `redaction` | `object` - Options for redacting potentially sensitive data from error metadata. See [Redaction of potentially sensitive data](/reference/advanced-config.md#redaction). |
+| `retryBackoff` | `(min: number, max: number, attempt: number) => number;` - A function that calculates how long to sleep, in seconds, before the next request retry<br>_Default:_ A built-in function that uses exponential backoff with jitter. |
 
 ## Using the Client in a Function-as-a-Service Environment [client-faas-env]
 
 This section illustrates the best practices for leveraging the {{es}} client in a Function-as-a-Service (FaaS) environment. The most influential optimization is to initialize the client outside of the function, the global scope. This practice does not only improve performance but also enables background functionality as – for example – [sniffing](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how). The following examples provide a skeleton for the best practices.
 
-
 ### GCP Cloud Functions [_gcp_cloud_functions]
 
 ```js
@@ -369,7 +369,6 @@ exports.testFunction = async function (req, res) {
 }
 ```
 
-
 ### AWS Lambda [_aws_lambda]
 
 ```js
@@ -386,7 +385,6 @@ exports.handler = async function (event, context) {
 }
 ```
 
-
 ### Azure Functions [_azure_functions]
 
 ```js
@@ -406,10 +404,9 @@ module.exports = async function (context, req) {
 Resources used to assess these recommendations:
 
 * [GCP Cloud Functions: Tips & Tricks](https://cloud.google.com/functions/docs/bestpractices/tips#use_global_variables_to_reuse_objects_in_future_invocations)
-* [Best practices for working with AWS Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/best-practices.md)
+* [Best practices for working with AWS Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/best-practices.html)
 * [Azure Functions Python developer guide](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-python?tabs=azurecli-linux%2Capplication-level#global-variables)
-* [AWS Lambda: Comparing the effect of global scope](https://docs.aws.amazon.com/lambda/latest/operatorguide/global-scope.md)
-
+* [AWS Lambda: Comparing the effect of global scope](https://docs.aws.amazon.com/lambda/latest/operatorguide/global-scope.html)
 
 ## Connecting through a proxy [client-connect-proxy]
 
@@ -421,7 +418,6 @@ If you need to pass through an http(s) proxy for connecting to {{es}}, the clien
 In versions 8.0+ of the client, the default `Connection` type is set to `UndiciConnection`, which does not support proxy configurations. To use a proxy, you will need to use the `HttpConnection` class from `@elastic/transport` instead.
 ::::
 
-
 ```js
 import { HttpConnection } from '@elastic/transport'
 
@@ -455,7 +451,6 @@ const client = new Client({
 })
 ```
 
-
 ## Error handling [client-error-handling]
 
 The client exposes a variety of error objects that you can use to enhance your error handling. You can find all the error objects inside the `errors` key in the client.
@@ -467,9 +462,8 @@ console.log(errors)
 
 You can find the errors exported by the client in the table below.
 
-|     |     |     |
-| --- | --- | --- |
 | **Error** | **Description** | **Properties** |
+| --- | --- | --- |
 | `ElasticsearchClientError` | Every error inherits from this class, it is the basic error generated by the client. | * `name` - `string`<br>* `message` - `string`<br> |
 | `TimeoutError` | Generated when a request exceeds the `requestTimeout` option. | * `name` - `string`<br>* `message` - `string`<br>* `meta` - `object`, contains all the information about the request<br> |
 | `ConnectionError` | Generated when an error occurs during the request, it can be a connection error or a malformed stream of data. | * `name` - `string`<br>* `message` - `string`<br>* `meta` - `object`, contains all the information about the request<br> |
@@ -506,7 +500,6 @@ const client = new Client({
 })
 ```
 
-
 ## Closing a client’s connections [close-connections]
 
 If you would like to close all open connections being managed by an instance of the client, use the `close()` function:
@@ -518,7 +511,6 @@ const client = new Client({
 client.close();
 ```
 
-
 ## Automatic product check [product-check]
 
 Since v7.14.0, the client performs a required product check before the first call. This pre-flight product check allows the client to establish the version of Elasticsearch that it is communicating with. The product check requires one additional HTTP request to be sent to the server as part of the request pipeline before the main API call is sent. In most cases, this will succeed during the very first API call that the client sends. Once the product check completes, no further product check HTTP requests are sent for subsequent API calls.

docs/reference/getting-started.md

@@ -45,15 +45,11 @@ const client = new Client({
 
 Your Elasticsearch endpoint can be found on the **My deployment** page of your deployment:
 
-:::{image} ../images/es-endpoint.jpg
-:alt: Finding Elasticsearch endpoint
-:::
+![Finding Elasticsearch endpoint](images/es-endpoint.jpg)
 
 You can generate an API key on the **Management** page under Security.
 
-:::{image} ../images/create-api-key.png
-:alt: Create API key
-:::
+![Create API key](images/create-api-key.png)
 
 For other connection options, refer to the [*Connecting*](/reference/connecting.md) section.
 

docs/reference/index.md

@@ -8,7 +8,6 @@ mapped_pages:
 
 This is the official Node.js client for {{es}}. This page gives a quick overview about the features of the client.
 
-
 ## Features [_features]
 
 * One-to-one mapping with REST API.
@@ -19,7 +18,6 @@ This is the official Node.js client for {{es}}. This page gives a quick overview
 * Child client support.
 * TypeScript support out of the box.
 
-
 ### Install multiple versions [_install_multiple_versions]
 
 If you are using multiple versions of {{es}}, you need to use multiple versions of the client as well. In the past, installing multiple versions of the same package was not possible, but with `npm v6.9`, you can do it via aliasing.
@@ -74,5 +72,3 @@ npm install esmain@github:elastic/elasticsearch-js
 ::::{warning}
 This command installs the main branch of the client which is not considered stable.
 ::::
-
-

docs/reference/installation.md

@@ -21,45 +21,41 @@ npm install @elastic/elasticsearch@<major>
 
 To learn more about the supported major versions, please refer to the [Compatibility matrix](#js-compatibility-matrix).
 
-
 ## Node.js support [nodejs-support]
 
 ::::{note}
 The minimum supported version of Node.js is `v18`.
 ::::
 
-
 The client versioning follows the {{stack}} versioning, this means that major, minor, and patch releases are done following a precise schedule that often does not coincide with the [Node.js release](https://nodejs.org/en/about/releases/) times.
 
 To avoid support insecure and unsupported versions of Node.js, the client **will drop the support of EOL versions of Node.js between minor releases**. Typically, as soon as a Node.js version goes into EOL, the client will continue to support that version for at least another minor release. If you are using the client with a version of Node.js that will be unsupported soon, you will see a warning in your logs (the client will start logging the warning with two minors in advance).
 
 Unless you are **always** using a supported version of Node.js, we recommend defining the client dependency in your `package.json` with the `~` instead of `^`. In this way, you will lock the dependency on the minor release and not the major. (for example, `~7.10.0` instead of `^7.10.0`).
 
-| Node.js Version | Node.js EOL date | End of support |
-| --- | --- | --- |
-| `8.x` | December 2019 | `7.11` (early 2021) |
-| `10.x` | April 2021 | `7.12` (mid 2021) |
-| `12.x` | April 2022 | `8.2` (early 2022) |
-| `14.x` | April 2023 | `8.8` (early 2023) |
-| `16.x` | September 2023 | `8.11` (late 2023) |
-
+| Node.js Version | Node.js EOL date | End of support      |
+| --------------- | ---------------- | ------------------- |
+| `8.x`           | December 2019    | `7.11` (early 2021) |
+| `10.x`          | April 2021       | `7.12` (mid 2021)   |
+| `12.x`          | April 2022       | `8.2` (early 2022)  |
+| `14.x`          | April 2023       | `8.8` (early 2023)  |
+| `16.x`          | September 2023   | `8.11` (late 2023)  |
+| `18.x`          | April 2025       | `9.2` (late 2025)   |
 
 ## Compatibility matrix [js-compatibility-matrix]
 
 Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of {{es}} without breaking. It does not mean that the client automatically supports new features of newer {{es}} versions; it is only possible after a release of a new client version. For example, a 8.12 client version won’t automatically support the new features of the 8.13 version of {{es}}, the 8.13 client version is required for that. {{es}} language clients are only backwards compatible with default distributions and without guarantees made.
 
 | {{es}} Version | Client Version | Supported |
-| --- | --- | --- |
-| `8.x` | `8.x` | `8.x` |
-| `7.x` | `7.x` | `7.17` |
-| `6.x` | `6.x` |  |
-| `5.x` | `5.x` |  |
-
+| -------------- | -------------- | --------- |
+| `9.x`          | `9.x`          | `9.x`     |
+| `8.x`          | `8.x`          | `8.x`     |
+| `7.x`          | `7.x`          | `7.17`    |
+| `6.x`          | `6.x`          |           |
+| `5.x`          | `5.x`          |           |
 
 ### Browser [_browser]
 
 ::::{warning}
 There is no official support for the browser environment. It exposes your {{es}} instance to everyone, which could lead to security issues. We recommend you to write a lightweight proxy that uses this client instead, you can see a proxy example [here](https://github.com/elastic/elasticsearch-js/tree/master/docs/examples/proxy).
 ::::
-
-

docs/reference/observability.md

@@ -15,7 +15,6 @@ Correlating events can be hard, especially if your applications have a large cod
 
 All of these observability features are documented below.
 
-
 ## OpenTelemetry [_opentelemetry]
 
 The client supports OpenTelemetry’s [zero-code instrumentation](https://opentelemetry.io/docs/zero-code/js/) to enable tracking each client request as an [OpenTelemetry span](https://opentelemetry.io/docs/concepts/signals/traces/#spans). These spans follow all of the [semantic OpenTelemetry conventions for Elasticsearch](https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/) except for `db.query.text`.
@@ -36,7 +35,6 @@ To start sending Elasticsearch trace data to your OpenTelemetry endpoint, follow
 node --require '@opentelemetry/auto-instrumentations-node/register' index.js
 ```
 
-
 ## Events [_events]
 
 The client is an event emitter. This means that you can listen for its events to add additional logic to your code, without needing to change the client’s internals or how you use the client. You can find the events' names by accessing the `events` key of the client:
@@ -65,16 +63,75 @@ client.diagnostic.on('response', (err, result) => {
 })
 ```
 
+### Event types
+
 The client emits the following events:
 
-|     |     |
-| --- | --- |
-| `serialization` | Emitted before starting serialization and compression. If you want to measure this phase duration, you should measure the time elapsed between this event and `request`.<br><br>```js<br>client.diagnostic.on('serialization', (err, result) => {<br>  console.log(err, result)<br>})<br>```<br> |
-| `request` | Emitted before sending the actual request to {{es}} *(emitted multiple times in case of retries)*.<br><br>```js<br>client.diagnostic.on('request', (err, result) => {<br>  console.log(err, result)<br>})<br>```<br> |
-| `deserialization` | Emitted before starting deserialization and decompression. If you want to measure this phase duration, you should measure the time elapsed between this event and `response`. *(This event might not be emitted in certain situations)*.<br><br>```js<br>client.diagnostic.on('deserialization', (err, result) => {<br>  console.log(err, result)<br>})<br>```<br> |
-| `response` | Emitted once {{es}} response has been received and parsed.<br><br>```js<br>client.diagnostic.on('response', (err, result) => {<br>  console.log(err, result)<br>})<br>```<br> |
-| `sniff` | Emitted when the client ends a sniffing request.<br><br>```js<br>client.diagnostic.on('sniff', (err, result) => {<br>  console.log(err, result)<br>})<br>```<br> |
-| `resurrect` | Emitted if the client is able to resurrect a dead node.<br><br>```js<br>client.diagnostic.on('resurrect', (err, result) => {<br>  console.log(err, result)<br>})<br>```<br> |
+#### `serialization`
+
+Emitted before starting serialization and compression. If you want to measure this phase duration, you should measure the time elapsed between this event and `request`.
+
+```js
+client.diagnostic.on("serialization", (err, result) => {
+  console.log(err, result)
+})
+```
+
+#### `request`
+
+Emitted before sending the actual request to {{es}} _(emitted multiple times in case of retries)_.
+
+```js
+client.diagnostic.on("request", (err, result) => {
+  console.log(err, result)
+})
+```
+
+#### `deserialization`
+
+Emitted before starting deserialization and decompression. If you want to measure this phase duration, you should measure the time elapsed between this event and `response`.
+
+This event might not be emitted in certain situations:
+
+* When `asStream` is set to true, the response is returned in its raw stream form before deserialization occurs
+* When a response is terminated early due to content length being too large
+* When a response is terminated early by an `AbortController`
+
+```js
+client.diagnostic.on("deserialization", (err, result) => {
+  console.log(err, result)
+})
+```
+
+#### `response`
+
+Emitted once {{es}} response has been received and parsed.
+
+```js
+client.diagnostic.on("response", (err, result) => {
+  console.log(err, result)
+})
+```
+
+#### `sniff`
+
+Emitted when the client ends a sniffing request.
+
+```js
+client.diagnostic.on("sniff", (err, result) => {
+  console.log(err, result)
+})
+```
+
+#### `resurrect`
+
+Emitted if the client is able to resurrect a dead node.
+
+```js
+client.diagnostic.on("resurrect", (err, result) => {
+  console.log(err, result)
+})
+```
 
 The values of `result` in `serialization`, `request`, `deserialization`, `response` and `sniff` are:
 
@@ -113,7 +170,6 @@ request: {
 };
 ```
 
-
 ### Events order [_events_order]
 
 The event order is described in the following graph, in some edge cases, the order is not guaranteed. You can find in [`test/acceptance/events-order.test.js`](https://github.com/elastic/elasticsearch-js/blob/main/test/acceptance/events-order.test.js) how the order changes based on the situation.
@@ -134,7 +190,6 @@ serialization
               └─▶ response
 ```
 
-
 ## Correlation ID [_correlation_id]
 
 Correlating events can be hard, especially if there are many events at the same time. The client offers you an automatic (and configurable) system to help you handle this problem.
@@ -176,7 +231,7 @@ const client = new Client({
   // it takes two parameters, the request parameters and options
   generateRequestId: function (params, options) {
     // your id generation logic
-    // must be syncronous
+    // must be synchronous
     return 'id'
   }
 })
@@ -193,7 +248,6 @@ client.search({
 }).then(console.log, console.log)
 ```
 
-
 ## Context object [_context_object]
 
 Sometimes, you might need to make some custom data available in your events, you can do that via the `context` option of a request:
@@ -263,10 +317,9 @@ client.search({
 }).then(console.log, console.log)
 ```
 
-
 ## Client name [_client_name]
 
-If you are using multiple instances of the client or if you are using multiple child clients *(which is the recommended way to have multiple instances of the client)*, you might need to recognize which client you are using. The `name` options help you in this regard.
+If you are using multiple instances of the client or if you are using multiple child clients _(which is the recommended way to have multiple instances of the client)_, you might need to recognize which client you are using. The `name` options help you in this regard.
 
 ```js
 const { Client } = require('@elastic/elasticsearch')
@@ -309,7 +362,6 @@ child.search({
 }).then(console.log, console.log)
 ```
 
-
 ## X-Opaque-Id support [_x_opaque_id_support]
 
 To improve observability, the client offers an easy way to configure the `X-Opaque-Id` header. If you set the `X-Opaque-Id` in a specific request, this allows you to discover this identifier in the [deprecation logs](docs-content://deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md#deprecation-logging), helps you with [identifying search slow log origin](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) as well as [identifying running tasks](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks).
@@ -348,4 +400,3 @@ client.search({
   opaqueId: 'my-search'
 }).then(console.log, console.log)
 ```
-

docs/reference/timeout-best-practices.md

@@ -0,0 +1,13 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/timeout-best-practices.html
+---
+
+# Timeout best practices [timeout-best-practices]
+
+Starting in 9.0.0, this client is configured to not time out any HTTP request by default. {{es}} will always eventually respond to any request, even if it takes several minutes. Reissuing a request that it has not responded to yet can cause performance side effects. See the [official {{es}} recommendations for HTTP clients](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more information.
+
+Prior to 9.0, this client was configured by default to operate like many HTTP client libraries do, by using a relatively short (30 second) timeout on all requests sent to {{es}}, raising a `TimeoutError` when that time period elapsed without receiving a response.
+
+If you need to set timeouts on Elasticsearch requests, setting the `requestTimeout` value to a millisecond value will cause this client to operate as it did prior to 9.0.
+

docs/reference/toc.yml

@@ -31,4 +31,5 @@ toc:
       - file: update_examples.md
       - file: update_by_query_examples.md
       - file: reindex_examples.md
-  - file: client-helpers.md
+  - file: client-helpers.md
+  - file: timeout-best-practices.md

docs/reference/typescript.md

@@ -13,8 +13,6 @@ The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g
 The client is developed against the [latest](https://www.npmjs.com/package/typescript?activeTab=versions) version of TypeScript. Furthermore, unless you have set `skipLibCheck` to `true`, you should configure `esModuleInterop` to `true`.
 ::::
 
-
-
 ## Example [_example]
 
 ```ts
@@ -74,7 +72,6 @@ async function run () {
 run().catch(console.log)
 ```
 
-
 ## Request & Response types [_request_response_types]
 
 You can import the full TypeScript requests & responses definitions as it follows:
@@ -82,10 +79,3 @@ You can import the full TypeScript requests & responses definitions as it follow
 ```ts
 import { estypes } from '@elastic/elasticsearch'
 ```
-
-If you need the legacy definitions with the body, you can do the following:
-
-```ts
-import { estypesWithBody } from '@elastic/elasticsearch'
-```
-

docs/release-notes/breaking-changes.md

@@ -1,28 +1,55 @@
 ---
-navigation_title: "Elasticsearch JavaScript Client"
+navigation_title: "Breaking changes"
 ---
 
 # Elasticsearch JavaScript Client breaking changes [elasticsearch-javascript-client-breaking-changes]
-Before you upgrade, carefully review the Elasticsearch JavaScript Client breaking changes and take the necessary steps to mitigate any issues. 
 
-To learn how to upgrade, check out <upgrade docs>.
+Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elasticsearch JavaScript Client breaking changes and take the necessary steps to mitigate any issues. To learn how to upgrade, check [Upgrade](docs-content://deploy-manage/upgrade.md).
 
 % ## Next version [elasticsearch-javascript-client-versionnext-breaking-changes]
-% **Release date:** Month day, year
 
-% ::::{dropdown} Title of breaking change 
+% ::::{dropdown} Title of breaking change
 % Description of the breaking change.
 % For more information, check [PR #](PR link).
 % **Impact**<br> Impact of the breaking change.
 % **Action**<br> Steps for mitigating deprecation impact.
 % ::::
 
-% ## 9.0.0 [elasticsearch-javascript-client-900-breaking-changes]
-% **Release date:** March 25, 2025
+## 9.0.0 [elasticsearch-javascript-client-900-breaking-changes]
 
-% ::::{dropdown} Title of breaking change 
-% Description of the breaking change.
-% For more information, check [PR #](PR link).
-% **Impact**<br> Impact of the breaking change.
-% **Action**<br> Steps for mitigating deprecation impact.
-% ::::
+::::{dropdown} Changes to the optional body property
+
+In 8.x, every API function had a `body` property that would provide a place to put arbitrary values that should go in the HTTP request body, even if they were not noted in the specification or documentation. In 9.0, each API function still includes an optional `body` property, but TypeScript's type checker will disallow properties that should go in the root of the object. A `querystring` parameter has also been added that behaves the same as `body`, but inserts its values into the request querystring.
+
+**Impact**<br> Some adjustments to API calls may be necessary for code that used a `body` property 8.x, especially to appease the TypeScript type checker, but it should not have any impact on any code that was not using a `body` property. The `estypesWithBody` export and `typesWithBodyKey` module are no longer available.
+
+**Action**<br> Check existing code for use of the `body` property, and move any properties that should be in the root object according to the API function's request type definition. If using TypeScript, the TypeScript type checker will surface most of these issues for you. Also look for any imports of `estypesWithBody` or `typesWithBodyKey` and update them to `estypes` and `types`, respectively.
+::::
+
+::::{dropdown} Changes to API parameter collation into an HTTP request
+
+The logic for where each parameter in an API function call should be added to its HTTP request has been updated:
+
+1. If recognized as a `body` parameter according to the Elasticsearch specification, put it in the JSON body
+2. If recognized as a `path` parameter, put it in the URL path
+3. If recognized as a `query` parameter or a "common" query parameter (e.g. `pretty`, `error_trace`), put it in the querystring
+4. If not recognized, and this API accepts a JSON body, put it in the JSON body
+5. If not recognized and this API does not accept a JSON body, put it in the querystring
+
+The first two steps are identical in 8.x. The final three steps replace the logic from 8.x that put all unrecognized parameters in the querystring.
+
+**Impact**<br> Some parameters that were sent via querystring to Elasticsearch may be sent in the JSON request body, and vice versa.
+
+**Action**<br> If Elasticsearch sends back an error response due to a request not being valid, verify with the client's TypeScript type definitions, or via the docs, that the parameters your code passes are correct.
+::::
+
+::::{dropdown} Removal of the default 30-second timeout on all API calls
+
+The default 30-second timeout on all HTTP requests sent to Elasticsearch has been dropped in favor of having no timeout set at all. The previous behavior still works as it did when setting the `requestTimeout` value.
+
+See pull request [#2573](https://github.com/elastic/elasticsearch-js/pull/2573) for more information.
+
+**Impact**<br> Requests to Elasticsearch that used to time out after 30 seconds will now wait for as long as it takes for Elasticsearch to respond.
+
+**Action**<br> In environments where it is not ideal to wait for an API response indefinitely, manually setting the `requestTimeout` option when instantiating the client still works as it did in 8.x.
+::::

docs/release-notes/deprecations.md

@@ -1,24 +1,17 @@
 ---
-navigation_title: "Elasticsearch JavaScript Client"
+navigation_title: "Deprecations"
 ---
 
 # Elasticsearch JavaScript Client deprecations [elasticsearch-javascript-client-deprecations]
-Review the deprecated functionality for your Elasticsearch JavaScript Client version. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade.
+Over time, certain Elastic functionality becomes outdated and is replaced or removed. To help with the transition, Elastic deprecates functionality for a period before removal, giving you time to update your applications.
 
-To learn how to upgrade, check out <uprade docs>.
+Review the deprecated functionality for the Elasticsearch JavaScript Client. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md).
+
+## 9.0.0 [elasticsearch-javascript-client-900-deprecations]
+
+_No deprecations_
 
 % ## Next version
-% **Release date:** Month day, year
-
-% ::::{dropdown} Deprecation title
-% Description of the deprecation.
-% For more information, check [PR #](PR link).
-% **Impact**<br> Impact of deprecation. 
-% **Action**<br> Steps for mitigating deprecation impact.
-% ::::
-
-% ## 9.0.0 [elasticsearch-javascript-client-900-deprecations]
-% **Release date:** March 25, 2025
 
 % ::::{dropdown} Deprecation title
 % Description of the deprecation.

docs/release-notes/index.md

@@ -1,27 +1,61 @@
 ---
 navigation_title: "Elasticsearch JavaScript Client"
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/changelog-client.html
 ---
 
 # Elasticsearch JavaScript Client release notes [elasticsearch-javascript-client-release-notes]
 
-Review the changes, fixes, and more in each version of Elasticsearch JavaScript Client. 
+Review the changes, fixes, and more in each version of Elasticsearch JavaScript Client.
 
 To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).
 
-% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections. 
+% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections.
 
 % ## version.next [elasticsearch-javascript-client-next-release-notes]
-% **Release date:** Month day, year
 
 % ### Features and enhancements [elasticsearch-javascript-client-next-features-enhancements]
-% * 
+% \*
 
 % ### Fixes [elasticsearch-javascript-client-next-fixes]
-% * 
+% \*
 
-## 9.0.0 [elasticsearch-javascript-client-900-release-notes]
-**Release date:** March 25, 2025
+## 9.0.3
 
-### Features and enhancements [elasticsearch-javascript-client-900-features-enhancements]
+### Fixes [elasticsearch-javascript-client-9.0.3-fixes]
 
-### Fixes [elasticsearch-javascript-client-900-fixes]
+**Improved compatibility with Elasticsearch 9.0:** Several fixes and improvements have been made to APIs and TypeScript type definitions to better reflect the Elasticsearch 9.0 specification.
+
+## 9.0.2
+
+### Fixes [elasticsearch-javascript-client-9.0.2-fixes]
+
+**Remove dangling references to `typesWithBodyKey`:** the `typesWithBodyKey.ts` file and `estypesWithBody` export were removed in 9.0.0 but were still being referenced in the `index.d.ts` file that declares TypeScript types. This reference has been removed.
+
+## 9.0.1
+
+### Fixes [elasticsearch-javascript-client-9.0.1-fixes]
+
+**Reinstate `nodeFilter` and node `roles` feature:** The docs note a `nodeFilter` option on the client that will, by default, filter the nodes based on any `roles` values that are set at instantiation. At some point, this functionality was partially disabled. This brings the feature back, ensuring that it matches what the documentation has said it does all along.
+
+**Ensure Apache Arrow ES|QL helper uses async iterator:** the [`esql.toArrowReader()` helper function](/reference/client-helpers.md#_toarrowreader) was trying to return `RecordBatchStreamReader`—a synchronous iterator—despite the fact that the `apache-arrow` package was, in most cases, automatically coercing it to `AsyncRecordBatchStreamReader`, its asynchronous counterpart. It now is always returned as an async iterator.
+
+## 9.0.0 [elasticsearch-javascript-client-9.0.0-release-notes]
+
+### Features and enhancements [elasticsearch-javascript-client-9.0.0-features-enhancements]
+
+- **Compatibility with Elasticsearch 9.0:** All changes and additions to Elasticsearch APIs for its 9.0 release are reflected in this release.
+- **Serverless client merged in:** the `@elastic/elasticsearch-serverless` client is being deprecated, and its functionality has been merged back into this client. This should have zero impact on the way the client works by default, except that a new `serverMode` option has been added. When it's explicitly set to `"serverless"` by a user, a few default settings and behaviors are changed:
+
+  - turns off sniffing and ignores any sniffing-related options
+  - ignores all nodes passed in config except the first one, and ignores any node filtering and selecting options
+  - enables compression and `TLSv1_2_method` (same as when configured for Elastic Cloud)
+  - adds an `elastic-api-version` HTTP header to all requests
+  - uses `CloudConnectionPool` by default instead of `WeightedConnectionPool`
+  - turns off vendored `content-type` and `accept` headers in favor or standard MIME types
+
+  Docstrings for types that differ between stack and serverless have also been updated to indicate when that is the case.
+
+- **Improved Cloud ID parsing:** when using a Cloud ID as the `cloud` parameter to instantiate the client, that ID was assumed to be in the correct format. New assertions have been added to verify that format and throw a `ConfigurationError` if it is invalid. See [#2694](https://github.com/elastic/elasticsearch-js/issues/2694).
+
+% ### Fixes [elasticsearch-javascript-client-9.0.0-fixes]

docs/release-notes/known-issues.md

@@ -1,10 +1,14 @@
 ---
-navigation_title: "Elasticsearch JavaScript Client"
+navigation_title: "Known issues"
 
 ---
 
 # Elasticsearch JavaScript Client known issues [elasticsearch-javascript-client-known-issues]
 
+## 9.0.0 
+
+_No known issues_
+
 % Use the following template to add entries to this page.
 
 % :::{dropdown} Title of known issue
@@ -17,4 +21,4 @@ navigation_title: "Elasticsearch JavaScript Client"
 % **Resolved**
 % On [Month/Day/Year], this issue was resolved.
 
-:::
+% :::

index.d.ts

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 import Client from './lib/client'
@@ -22,6 +8,6 @@ import SniffingTransport from './lib/sniffingTransport'
 
 export * from '@elastic/transport'
 export * as estypes from './lib/api/types'
-export * as estypesWithBody from './lib/api/typesWithBodyKey'
 export { Client, SniffingTransport }
 export type { ClientOptions, NodeOptions } from './lib/client'
+export * as helpers from './lib/helpers'

index.js

@@ -1,20 +1,6 @@
 /*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 'use strict'

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/elasticsearch",
-  "version": "9.0.0-alpha.4",
-  "versionCanary": "9.0.0-canary.0",
+  "version": "9.0.3",
+  "versionCanary": "9.0.2-canary.0",
   "description": "The official Elasticsearch client for Node.js",
   "main": "./index.js",
   "types": "index.d.ts",
@@ -18,10 +18,12 @@
     "test:coverage-100": "npm run build && tap --coverage --100",
     "test:coverage-report": "npm run build && tap --coverage && nyc report --reporter=text-lcov > coverage.lcov",
     "test:coverage-ui": "npm run build && tap --coverage --coverage-report=html",
-    "test:integration": "tsc && node test/integration/index.js",
+    "test:integration-build": "npm run build && node test/integration/index.js",
+    "test:integration": "npm run test:integration-build && env tap run --jobs=1 --reporter=junit --reporter-file=report-junit.xml generated-tests/",
     "lint": "ts-standard src",
     "lint:fix": "ts-standard --fix src",
     "license-checker": "license-checker --production --onlyAllow='MIT;Apache-2.0;Apache1.1;ISC;BSD-3-Clause;BSD-2-Clause;0BSD'",
+    "license-header": "./scripts/check-spdx",
     "prebuild": "npm run clean-build && npm run lint",
     "build": "tsc && rm lib/package.json && mv lib/src/* lib/ && rm -rf lib/src",
     "clean-build": "rimraf ./lib && mkdir lib",
@@ -56,11 +58,11 @@
     "node": ">=18"
   },
   "devDependencies": {
-    "@elastic/request-converter": "8.17.0",
+    "@elastic/request-converter": "9.1.1",
     "@sinonjs/fake-timers": "14.0.0",
     "@types/debug": "4.1.12",
-    "@types/ms": "0.7.34",
-    "@types/node": "22.13.5",
+    "@types/ms": "2.1.0",
+    "@types/node": "22.15.32",
     "@types/sinonjs__fake-timers": "8.1.5",
     "@types/split2": "4.2.3",
     "@types/stoppable": "1.1.3",
@@ -75,22 +77,22 @@
     "node-abort-controller": "3.1.1",
     "node-fetch": "2.7.0",
     "ora": "5.4.1",
-    "proxy": "1.0.2",
-    "rimraf": "3.0.2",
-    "semver": "7.6.3",
+    "proxy": "2.2.0",
+    "rimraf": "6.0.1",
+    "semver": "7.7.2",
     "split2": "4.2.0",
     "stoppable": "1.1.0",
-    "tap": "21.0.2",
+    "tap": "21.1.0",
     "ts-node": "10.9.2",
     "ts-standard": "12.0.2",
-    "typescript": "5.7.3",
+    "typescript": "5.8.3",
     "workq": "3.0.0",
     "xmlbuilder2": "3.1.1",
-    "zx": "7.2.3"
+    "zx": "8.5.5"
   },
   "dependencies": {
-    "@elastic/transport": "9.0.0-alpha.1",
-    "apache-arrow": "^18.0.0",
+    "@elastic/transport": "^9.0.1",
+    "apache-arrow": "18.x - 20.x",
     "tslib": "^2.4.0"
   },
   "tap": {

renovate.json

@@ -20,13 +20,15 @@
       "matchManagers": [
         "dockerfile"
       ],
-      "pinDigests": false
+      "pinDigests": false,
+      "automerge": true
     },
     {
       "matchDatasources": [
         "docker"
       ],
-      "pinDigests": false
+      "pinDigests": false,
+      "automerge": true
     }
   ]
 }