Auto-generated API code (#2878)

(cherry picked from commit b030084f24)

Co-authored-by: Josh Mock <joshua.mock@elastic.co>

.buildkite/Dockerfile

@@ -3,14 +3,14 @@ FROM node:$NODE_VERSION
 
 # Install required tools
 RUN apt-get clean -y && \
-    apt-get -qy update && \
-    apt-get -y install zip && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+  apt-get -qy update && \
+  apt-get -y install zip && \
+  apt-get clean && \
+  rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 WORKDIR /usr/src/app
 
 COPY package.json .
-RUN npm install --production=false
+RUN npm install
 
 COPY . .

.buildkite/Dockerfile-make

@@ -24,7 +24,7 @@ USER ${BUILDER_UID}:${BUILDER_GID}
 
 # install dependencies
 COPY package.json .
-RUN npm install --production=false
+RUN npm install
 
 # copy project files
 COPY . .

.buildkite/make.mjs

@@ -125,6 +125,13 @@ async function codegen (args) {
   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 $`npm run build`
+
+  // run docs example generation
+  if (version === 'main') {
+    await $`node ./scripts/generate-docs-examples.js`
+  } else {
+    await $`node ./scripts/generate-docs-examples.js ${version.split('.').slice(0, 2).join('.')}`
+  }
 }
 
 function onError (err) {

.buildkite/pipeline.yml

@@ -1,17 +1,20 @@
 ---
+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.15.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"
@@ -21,9 +24,6 @@ steps:
   - wait: ~
     continue_on_failure: true
   - label: ":junit: Test results"
-    agents:
-      provider: "gcp"
-      image: family/core-ubuntu-2204
     plugins:
       - junit-annotate#v2.4.1:
           artifacts: "junit-output/junit-*.xml"

.buildkite/run-client.sh

@@ -10,22 +10,29 @@ export NODE_VERSION=${NODE_VERSION:-18}
 
 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

@@ -5,3 +5,7 @@ elasticsearch
 .git
 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.md

@@ -1,50 +0,0 @@
----
-name: 🐛 Bug report
-about: Create a report to help us improve
-labels: ["Category: Bug"]
----
-
-It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one.
-
-**Please read this entire template before posting any issue. If you ignore these instructions
-and post an issue here that does not follow the instructions, your issue might be closed,
-locked, and assigned the `Category: Not an issue` label.**
-
-## 🐛 Bug Report
-
-A clear and concise description of what the bug is.
-
-## To Reproduce
-
-Steps to reproduce the behavior:
-
-Paste your code here:
-
-```js
-
-```
-
-<!--
-In some cases, it might be challenging to reproduce the bug in a few lines of code.
-You can fork the following repository, which contains all the configuration needed
-to spin up a three nodes Elasticsearch cluster with security enabled.
-The repository also contains a preconfigured client instance that you can use to reproduce the issue.
-https://github.com/delvedor/es-reproduce-issue
---->
-
-## Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-Paste the results here:
-
-```js
-
-```
-
-## Your Environment
-
-- *node version*: 6,8,10
-- `@elastic/elasticsearch` *version*: >=7.0.0
-- *os*: Mac, Windows, Linux
-- *any other relevant information*

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,66 @@
+---
+name: 🐛 Bug report
+description: Create a report to help us improve
+labels: ["Category: Bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one.
+
+        **Please read this entire template before posting any issue. If you ignore these instructions
+        and post an issue here that does not follow the instructions, your issue might be closed,
+        locked, and assigned the `Category: Not an issue` label.**
+
+  - type: textarea
+    id: bug-report
+    attributes:
+      label: 🐛 Bug report
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: To reproduce
+      description: Steps to reproduce the behavior
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: input
+    id: node-js-version
+    attributes:
+      label: Node.js version
+      placeholder: 18.x, 20.x, etc.
+    validations:
+      required: true
+
+  - type: input
+    id: client-version
+    attributes:
+      label: "@elastic/elasticsearch version"
+      placeholder: 7.17.0, 8.14.1, etc.
+    validations:
+      required: true
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: Ubuntu 22.04, macOS, etc.
+    validations:
+      required: true
+
+  - type: input
+    id: env-info
+    attributes:
+      label: Any other relevant environment information

.github/ISSUE_TEMPLATE/feature.md

@@ -1,23 +0,0 @@
----
-name: 🚀 Feature Proposal
-about: Submit a proposal for a new feature
-labels: ["Category: Feature"]
----
-
-It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one.
-
-**Please read this entire template before posting any issue. If you ignore these instructions
-and post an issue here that does not follow the instructions, your issue might be closed,
-locked, and assigned the `Category: Not an issue` label.**
-
-## 🚀 Feature Proposal
-
-A clear and concise description of what the feature is.
-
-## Motivation
-
-Please outline the motivation for the proposal.
-
-## Example
-
-Please provide an example for how this feature would be used.

.github/ISSUE_TEMPLATE/feature.yaml

@@ -0,0 +1,33 @@
+---
+name: 🚀 Feature Proposal
+description: Submit a proposal for a new feature
+labels: ["Category: Feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one.
+
+        **Please read this entire template before posting any issue. If you ignore these instructions
+        and post an issue here that does not follow the instructions, your issue might be closed,
+        locked, and assigned the `Category: Not an issue` label.**
+
+  - type: textarea
+    id: feature-proposal
+    attributes:
+      label: 🚀 Feature Proposal
+      description: A clear and concise description of what the feature is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: Please outline the motivation for the proposal.
+
+  - type: textarea
+    id: example
+    attributes:
+      label: Example
+      description: Please provide an example for how this feature would be used.

.github/ISSUE_TEMPLATE/question.md

@@ -1,11 +0,0 @@
----
-name: 💬 Questions / Help
-about: If you have questions, please check our Gitter or Help repo
-labels: ["Category: Question"]
----
-
-## 💬 Questions and Help
-
-### Please note that this issue tracker is not a help forum and this issue may be closed.
-
-It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one.

.github/ISSUE_TEMPLATE/question.yaml

@@ -0,0 +1,21 @@
+---
+name: 💬 Questions / Help
+description: If you have questions, please check our community forum or support
+labels: ["Category: Question"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ### Please note that this issue tracker is not a help forum and this issue may be closed.
+
+        Please check our [community forum](https://discuss.elastic.co/) or [contact Elastic support](https://www.elastic.co/support) if your issue is not specifically related to the documented functionality of this client library.
+
+        It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one.
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: Your question or comment
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/security.md

@@ -1,6 +0,0 @@
----
-name: 👮 Security Issue
-about: Responsible Disclosure
----
-
-If you want to report a security issue, please take a look at [elastic/security](https://www.elastic.co/community/security).

.github/ISSUE_TEMPLATE/security.yaml

@@ -0,0 +1,8 @@
+---
+name: 👮 Security Issue
+description: Responsible disclosure
+body:
+  - type: markdown
+    attributes:
+      value: |
+        If you want to report a security issue, please take a look at [elastic/security](https://www.elastic.co/community/security).

.github/make.sh

@@ -37,7 +37,7 @@ product="elastic/elasticsearch-js"
 output_folder=".buildkite/output"
 codegen_folder=".buildkite/output"
 OUTPUT_DIR="$repo/${output_folder}"
-NODE_JS_VERSION=18
+NODE_JS_VERSION=22
 WORKFLOW=${WORKFLOW-staging}
 mkdir -p "$OUTPUT_DIR"
 
@@ -46,84 +46,84 @@ echo -e "\033[34;1mINFO:\033[0m VERSION ${STACK_VERSION}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m OUTPUT_DIR ${OUTPUT_DIR}\033[0m"
 
 case $CMD in
-    clean)
-        echo -e "\033[36;1mTARGET: clean workspace $output_folder\033[0m"
-        rm -rf "$output_folder"
-        echo -e "\033[32;1mdone.\033[0m"
-        exit 0
-        ;;
-    assemble)
-        if [ -v $VERSION ]; then
-            echo -e "\033[31;1mTARGET: assemble -> missing version parameter\033[0m"
-            exit 1
-        fi
-        echo -e "\033[36;1mTARGET: assemble artifact $VERSION\033[0m"
-        TASK=release
-        TASK_ARGS=("$VERSION" "$output_folder")
-        ;;
-    codegen)
-        if [ -v "$VERSION" ] || [[ -z "$VERSION" ]]; then
-            # fall back to branch name or `main` if no VERSION is set
-            branch_name=$(git rev-parse --abbrev-ref HEAD)
-            if [[ "$branch_name" =~ ^[0-9]+\.[0-9]+ ]]; then
-              echo -e "\033[36;1mTARGET: codegen -> No VERSION argument found, using branch name: \`$branch_name\`\033[0m"
-              VERSION="$branch_name"
-            else
-              echo -e "\033[36;1mTARGET: codegen -> No VERSION argument found, using \`main\`\033[0m"
-              VERSION="main"
-            fi
-        fi
-        if [ "$VERSION" = 'main' ]; then
-          echo -e "\033[36;1mTARGET: codegen API $VERSION\033[0m"
-        else
-          echo -e "\033[36;1mTARGET: codegen API v$VERSION\033[0m"
-        fi
+clean)
+  echo -e "\033[36;1mTARGET: clean workspace $output_folder\033[0m"
+  rm -rf "$output_folder"
+  echo -e "\033[32;1mdone.\033[0m"
+  exit 0
+  ;;
+assemble)
+  if [ -v $VERSION ]; then
+    echo -e "\033[31;1mTARGET: assemble -> missing version parameter\033[0m"
+    exit 1
+  fi
+  echo -e "\033[36;1mTARGET: assemble artifact $VERSION\033[0m"
+  TASK=release
+  TASK_ARGS=("$VERSION" "$output_folder")
+  ;;
+codegen)
+  if [ -v "$VERSION" ] || [[ -z "$VERSION" ]]; then
+    # fall back to branch name or `main` if no VERSION is set
+    branch_name=$(git rev-parse --abbrev-ref HEAD)
+    if [[ "$branch_name" =~ ^[0-9]+\.([0-9]+|x) ]]; then
+      echo -e "\033[36;1mTARGET: codegen -> No VERSION argument found, using branch name: \`$branch_name\`\033[0m"
+      VERSION="$branch_name"
+    else
+      echo -e "\033[36;1mTARGET: codegen -> No VERSION argument found, using \`main\`\033[0m"
+      VERSION="main"
+    fi
+  fi
+  if [ "$VERSION" = 'main' ]; then
+    echo -e "\033[36;1mTARGET: codegen API $VERSION\033[0m"
+  else
+    echo -e "\033[36;1mTARGET: codegen API v$VERSION\033[0m"
+  fi
 
-        TASK=codegen
-        TASK_ARGS=("$VERSION")
-        ;;
-    docsgen)
-        if [ -v $VERSION ]; then
-            echo -e "\033[31;1mTARGET: docsgen -> missing version parameter\033[0m"
-            exit 1
-        fi
-        echo -e "\033[36;1mTARGET: generate docs for $VERSION\033[0m"
-        TASK=codegen
-        TASK_ARGS=("$VERSION" "$codegen_folder")
-        ;;
-    examplesgen)
-        echo -e "\033[36;1mTARGET: generate examples\033[0m"
-        TASK=codegen
-        TASK_ARGS=("$VERSION" "$codegen_folder")
-        ;;
-    bump)
-        if [ -v $VERSION ]; then
-            echo -e "\033[31;1mTARGET: bump -> missing version parameter\033[0m"
-            exit 1
-        fi
-        echo -e "\033[36;1mTARGET: bump to version $VERSION\033[0m"
-        TASK=bump
-        TASK_ARGS=("$VERSION")
-        ;;
-    bumpmatrix)
-      if [ -v $VERSION ]; then
-        echo -e "\033[31;1mTARGET: bumpmatrix -> missing version parameter\033[0m"
-        exit 1
-      fi
-      echo -e "\033[36;1mTARGET: bump stack in test matrix to version $VERSION\033[0m"
-      TASK=bumpmatrix
-      TASK_ARGS=("$VERSION")
-      ;;
-    *)
-        echo -e "\n'$CMD' is not supported right now\n"
-        echo -e "\nUsage:"
-        echo -e "\t $0 release \$VERSION\n"
-        echo -e "\t $0 bump \$VERSION"
-        echo -e "\t $0 codegen \$VERSION"
-        exit 1
+  TASK=codegen
+  TASK_ARGS=("$VERSION")
+  ;;
+docsgen)
+  if [ -v $VERSION ]; then
+    echo -e "\033[31;1mTARGET: docsgen -> missing version parameter\033[0m"
+    exit 1
+  fi
+  echo -e "\033[36;1mTARGET: generate docs for $VERSION\033[0m"
+  TASK=codegen
+  TASK_ARGS=("$VERSION" "$codegen_folder")
+  ;;
+examplesgen)
+  echo -e "\033[36;1mTARGET: generate examples\033[0m"
+  TASK=codegen
+  TASK_ARGS=("$VERSION" "$codegen_folder")
+  ;;
+bump)
+  if [ -v $VERSION ]; then
+    echo -e "\033[31;1mTARGET: bump -> missing version parameter\033[0m"
+    exit 1
+  fi
+  echo -e "\033[36;1mTARGET: bump to version $VERSION\033[0m"
+  TASK=bump
+  TASK_ARGS=("$VERSION")
+  ;;
+bumpmatrix)
+  if [ -v $VERSION ]; then
+    echo -e "\033[31;1mTARGET: bumpmatrix -> missing version parameter\033[0m"
+    exit 1
+  fi
+  echo -e "\033[36;1mTARGET: bump stack in test matrix to version $VERSION\033[0m"
+  TASK=bumpmatrix
+  TASK_ARGS=("$VERSION")
+  ;;
+*)
+  echo -e "\n'$CMD' is not supported right now\n"
+  echo -e "\nUsage:"
+  echo -e "\t $0 release \$VERSION\n"
+  echo -e "\t $0 bump \$VERSION"
+  echo -e "\t $0 codegen \$VERSION"
+  exit 1
+  ;;
 esac
 
-
 # ------------------------------------------------------- #
 # Build Container
 # ------------------------------------------------------- #
@@ -150,7 +150,7 @@ if [[ -z "${BUILDKITE+x}" ]] && [[ -z "${CI+x}" ]] && [[ -z "${GITHUB_ACTIONS+x}
     -u "$(id -u):$(id -g)" \
     --volume "$repo:/usr/src/elasticsearch-js" \
     --volume /usr/src/elasticsearch-js/node_modules \
-    --volume "$(realpath $repo/../elastic-client-generator-js):/usr/src/elastic-client-generator-js" \
+    --volume "$(realpath "$repo/../elastic-client-generator-js"):/usr/src/elastic-client-generator-js" \
     --env "WORKFLOW=$WORKFLOW" \
     --name make-elasticsearch-js \
     --rm \
@@ -159,6 +159,14 @@ if [[ -z "${BUILDKITE+x}" ]] && [[ -z "${CI+x}" ]] && [[ -z "${GITHUB_ACTIONS+x}
       node .buildkite/make.mjs --task $TASK ${TASK_ARGS[*]}"
 else
   echo -e "\033[34;1mINFO: Running in CI mode"
+
+  # determine branch to clone
+  GENERATOR_BRANCH="main"
+  if [[ "$VERSION" == 8.* ]]; then
+    GENERATOR_BRANCH="8.x"
+  fi
+  echo -e "\033[34;1mINFO: Generator branch: $GENERATOR_BRANCH"
+
   docker run \
     --volume "$repo:/usr/src/elasticsearch-js" \
     --volume /usr/src/elasticsearch-js/node_modules \
@@ -168,7 +176,7 @@ else
     --rm \
     $product \
     /bin/bash -c "cd /usr/src && \
-      git clone https://$CLIENTS_GITHUB_TOKEN@github.com/elastic/elastic-client-generator-js.git && \
+      git clone --branch $GENERATOR_BRANCH https://$CLIENTS_GITHUB_TOKEN@github.com/elastic/elastic-client-generator-js.git && \
       mkdir -p /usr/src/elastic-client-generator-js/output && \
       cd /usr/src/elasticsearch-js && \
       node .buildkite/make.mjs --task $TASK ${TASK_ARGS[*]}"
@@ -179,36 +187,36 @@ fi
 # ------------------------------------------------------- #
 
 if [[ "$CMD" == "assemble" ]]; then
-	if compgen -G ".buildkite/output/*" > /dev/null; then
-		echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
-	else
-		echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"
-		exit 1
-	fi
+  if compgen -G ".buildkite/output/*" >/dev/null; then
+    echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
+  else
+    echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"
+    exit 1
+  fi
 fi
 
 if [[ "$CMD" == "bump" ]]; then
-  if [ -n "$(git status --porcelain)" ]; then 
-		echo -e "\033[32;1mTARGET: successfully bumped client v$VERSION\033[0m"
-  else 
-		echo -e "\033[31;1mTARGET: failed bumped client v$VERSION\033[0m"
+  if [ -n "$(git status --porcelain)" ]; then
+    echo -e "\033[32;1mTARGET: successfully bumped client v$VERSION\033[0m"
+  else
+    echo -e "\033[31;1mTARGET: failed bumped client v$VERSION\033[0m"
     exit 1
   fi
 fi
 
 if [[ "$CMD" == "codegen" ]]; then
-  if [ -n "$(git status --porcelain)" ]; then 
-		echo -e "\033[32;1mTARGET: successfully generated client v$VERSION\033[0m"
-  else 
-		echo -e "\033[31;1mTARGET: failed generating client v$VERSION\033[0m"
+  if [ -n "$(git status --porcelain)" ]; then
+    echo -e "\033[32;1mTARGET: successfully generated client v$VERSION\033[0m"
+  else
+    echo -e "\033[31;1mTARGET: failed generating client v$VERSION\033[0m"
     exit 1
   fi
 fi
 
 if [[ "$CMD" == "docsgen" ]]; then
-    echo "TODO"
+  echo "TODO"
 fi
 
 if [[ "$CMD" == "examplesgen" ]]; then
-    echo "TODO"
+  echo "TODO"
 fi

.github/workflows/nodejs.yml

@@ -11,8 +11,10 @@ jobs:
     outputs:
       src-only: "${{ steps.changes.outputs.src-only }}"
     steps:
-      - uses: actions/checkout@v4
-      - uses: dorny/paths-filter/@v2.11.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          persist-credentials: false
+      - uses: dorny/paths-filter/@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
         id: changes
         with:
           filters: |
@@ -30,14 +32,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [18.x, 20.x, 22.x, 23.x]
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          persist-credentials: false
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -53,15 +57,21 @@ jobs:
         run: |
           npm run test:unit
 
+      - name: ECMAScript module test
+        run: |
+          npm run test:esm
+
   license:
     name: License check
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          persist-credentials: false
 
       - name: Use Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
         with:
           node-version: 22.x
 
@@ -72,3 +82,39 @@ jobs:
       - name: License checker
         run: |
           npm run license-checker
+
+  test-bun:
+    name: Test Bun
+    runs-on: ${{ matrix.os }}
+    needs: paths-filter
+    # only run if code relevant to unit tests was changed
+    if: needs.paths-filter.outputs.src-only == 'true'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          persist-credentials: false
+
+      - name: Use Bun
+        uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2
+
+      - name: Install
+        run: |
+          bun install
+
+      - name: Lint
+        run: |
+          bun run lint
+
+      - name: Unit test
+        run: |
+          bun run test:unit-bun
+
+      - name: ECMAScript module test
+        run: |
+          bun run test:esm

.github/workflows/npm-publish.yml

@@ -9,15 +9,16 @@ jobs:
   build:
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       id-token: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
+          persist-credentials: false
           ref: ${{ github.event.inputs.branch }}
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
         with:
-          node-version: "20.x"
+          node-version: "22.x"
           registry-url: "https://registry.npmjs.org"
       - run: npm install -g npm
       - run: npm install

.github/workflows/serverless-patch.yml

@@ -26,26 +26,28 @@ jobs:
         )
       )
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
+          persist-credentials: false
           repository: elastic/elasticsearch-js
           ref: main
           path: stack
           fetch-depth: 0
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
+          persist-credentials: false
           repository: elastic/elasticsearch-serverless-js
           ref: main
           path: serverless
       - name: Apply patch from stack to serverless
         id: apply-patch
         run: $GITHUB_WORKSPACE/stack/.github/workflows/serverless-patch.sh
-      - uses: peter-evans/create-pull-request@v6
+      - uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6
         with:
           token: ${{ secrets.GH_TOKEN }}
           path: serverless
-          title: 'Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}'
-          commit-message: 'Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}'
+          title: "Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}"
+          commit-message: "Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}"
           body-path: /tmp/pr_body
-          draft: '${{ steps.apply-patch.outputs.PR_DRAFT }}'
-          add-paths: ':!*.rej'
+          draft: "${{ steps.apply-patch.outputs.PR_DRAFT }}"
+          add-paths: ":!*.rej"

.github/workflows/stale.yml

@@ -8,7 +8,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v8
+      - uses: actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84 # v8
         with:
           stale-issue-label: stale
           stale-pr-label: stale

.gitignore

@@ -64,3 +64,11 @@ test/bundlers/parcel-test/.parcel-cache
 
 lib
 junit-output
+bun.lockb
+test-results
+processinfo
+.tap
+rest-api-spec
+yaml-rest-tests
+generated-tests
+schema

.npmignore

@@ -72,3 +72,8 @@ CODE_OF_CONDUCT.md
 CONTRIBUTING.md
 
 src
+bun.lockb
+.tap
+rest-api-spec
+yaml-rest-tests
+generated-tests

catalog-info.yaml

@@ -42,6 +42,9 @@ spec:
         main:
           branch: "main"
           cronline: "@daily"
-        8_14:
-          branch: "8.14"
+        8_x:
+          branch: "8.x"
+          cronline: "@daily"
+        8_14:
+          branch: "8.16"
           cronline: "@daily"

docs/basic-config.asciidoc

@@ -167,16 +167,19 @@ const client = new Client({
 ----
 
 |`nodeFilter`
-a|`function` - Filters which node not to use for a request. +
+a|`function` - Takes a `Connection` and returns `true` if it can be sent a request, otherwise `false`. +
 _Default:_
 [source,js]
 ----
-function defaultNodeFilter (node) {
-  // avoid master only nodes
-  if (node.roles.master === true &&
-      node.roles.data === false &&
-      node.roles.ingest === false) {
-    return false
+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
 }
@@ -252,8 +255,8 @@ const client = new Client({
 ----
 
 |`disablePrototypePoisoningProtection`
-|`boolean`, `'proto'`, `'constructor'` - By the default the client will protect you against prototype poisoning attacks. Read https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08[this article] to learn more. If needed you can disable prototype poisoning protection entirely or one of the two checks. Read the `secure-json-parse` https://github.com/fastify/secure-json-parse[documentation] to learn more. +
-_Default:_ `false`
+|`boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. Read https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08[this article] 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` https://github.com/fastify/secure-json-parse[documentation] to learn more. +
+_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. +

docs/changelog.asciidoc

@@ -1,6 +1,191 @@
 [[changelog-client]]
 == Release notes
 
+[discrete]
+=== 8.18.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Ensure Apache Arrow ES|QL helper uses async iterator
+
+The `esql.toArrowReader()` helper function 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.
+
+[discrete]
+=== 8.18.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix broken node roles and node filter
+
+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 instantition. 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.
+
+[discrete]
+=== 8.18.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.18`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.18/release-notes-8.18.0.html[here].
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== 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 https://github.com/elastic/elasticsearch-js/issues/2694[#2694].
+
+[discrete]
+=== 8.17.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.17`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.17/release-notes-8.17.0.html[here].
+
+[discrete]
+=== 8.16.3
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.16`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+=== 8.16.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.16`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+===== Drop testing artifacts from npm package
+
+Tap, the unit testing tool used by this project, was recently upgraded and started writing to a `.tap` directory. Since tests are run prior to an `npm publish` in CI, this directory was being included in the published package and bloating its size.
+
+[discrete]
+=== 8.16.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix ECMAScript imports
+
+Fixed package configuration to correctly support native ECMAScript `import` syntax.
+
+[discrete]
+=== 8.16.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.16`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.16/release-notes-8.16.0.html[here].
+
+[discrete]
+===== Support Apache Arrow in ES|QL helper
+
+The ES|QL helper can now return results as an Apache Arrow `Table` or `RecordBatchReader`, which enables high-performance calculations on ES|QL results, even if the response data is larger than the system's available memory. See <<esql-helper>> for more information.
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Pass prototype poisoning options to serializer correctly
+
+The client's `disablePrototypePoisoningProtection` option was set to `true` by default, but when it was set to any other value it was ignored, making it impossible to enable prototype poisoning protection without providing a custom serializer implementation.
+
+[discrete]
+=== 8.15.3
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.15`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+===== Drop testing artifacts from npm package
+
+Tap, the unit testing tool, was recently upgraded and started writing to a `.tap` directory. Since tests are run prior to an `npm publish` in CI, this directory was being included in the published package and bloating its size.
+
+[discrete]
+=== 8.15.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.15`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+=== 8.15.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.15`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+=== 8.15.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.15.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.15/release-notes-8.15.0.html[here].
+
+[discrete]
+===== OpenTelemetry zero-code instrumentation support
+
+For those that use an observability service that supports OpenTelemetry spans, the client will now automatically generate traces for each Elasticsearch request it makes.
+See {jsclient}/observability.html#_opentelemetry[the docs]
+for more information.
+
+[discrete]
+=== 8.14.1
+
+[discrete]
+==== Features
+
+[discrete]
+===== Improved support for Elasticsearch `8.14`
+
+Updated types based on fixes and changes to the Elasticsearch specification.
+
 [discrete]
 === 8.14.0
 
@@ -198,7 +383,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.9/release-notes-8.9.0.
 [discrete]
 ===== Allow document to be overwritten in `onDocument` iteratee of bulk helper https://github.com/elastic/elasticsearch-js/pull/1732[#1732]
 
-In the https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html#bulk-helper[bulk helper], documents could not be modified before being sent to Elasticsearch. It is now possible to https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html#_modifying_a_document_before_operation[modify a document] before sending it.
+In the {jsclient}/client-helpers.html#bulk-helper[bulk helper], documents could not be modified before being sent to Elasticsearch. It is now possible to {jsclient}/client-helpers.html#_modifying_a_document_before_operation[modify a document] before sending it.
 
 [discrete]
 ==== Fixes

docs/configuration.asciidoc

@@ -2,10 +2,11 @@
 == Configuration
 
 
-The client is designed to be easily configured for your needs. In the following 
+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-config>>
 * <<advanced-config>>
+* <<timeout-best-practices>>
 * <<child>>
 * <<client-testing>>

docs/connecting.asciidoc

@@ -1,7 +1,7 @@
 [[client-connecting]]
-== Connecting 
+== Connecting
 
-This page contains the information you need to connect and use the Client with 
+This page contains the information you need to connect and use the Client with
 {es}.
 
 **On this page**
@@ -19,7 +19,7 @@ This page contains the information you need to connect and use the Client with
 [discrete]
 === Authentication
 
-This document contains code snippets to show you how to connect to various {es} 
+This document contains code snippets to show you how to connect to various {es}
 providers.
 
 
@@ -27,18 +27,18 @@ providers.
 [[auth-ec]]
 ==== Elastic Cloud
 
-If you are using https://www.elastic.co/cloud[Elastic 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 
+If you are using https://www.elastic.co/cloud[Elastic 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.
 
-NOTE: 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 
+NOTE: 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 
+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 https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here]
 to know more.
@@ -61,18 +61,18 @@ const client = new Client({
 [[connect-self-managed-new]]
 === Connecting to a self-managed cluster
 
-By default {es} will start with security features like authentication and TLS 
-enabled. To connect to the {es} cluster you'll need to configure the Node.js {es} 
-client to use HTTPS with the generated CA certificate in order to make requests 
+By default {es} will start with security features like authentication and TLS
+enabled. To connect to the {es} cluster you'll need to configure the Node.js {es}
+client to use HTTPS with the generated CA certificate in order to make requests
 successfully.
 
-If you're just getting started with {es} we recommend reading the documentation 
-on https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html[configuring] 
-and 
-https://www.elastic.co/guide/en/elasticsearch/reference/current/starting-elasticsearch.html[starting {es}] 
+If you're just getting started with {es} we recommend reading the documentation
+on https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html[configuring]
+and
+https://www.elastic.co/guide/en/elasticsearch/reference/current/starting-elasticsearch.html[starting {es}]
 to ensure your cluster is running as expected.
 
-When you start {es} for the first time you'll see a distinct block like the one 
+When you start {es} for the first time you'll see a distinct block like the one
 below in the output from {es} (you may have to scroll up if it's been a while):
 
 [source,sh]
@@ -90,24 +90,24 @@ below in the output from {es} (you may have to scroll up if it's been a while):
 
 ----
 
-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 
+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.
 
 [discrete]
 [[auth-tls]]
 ==== TLS configuration
 
-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 
+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
 https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html[additional documentation for retrieving the CA certificate].
 
-Without any additional configuration you can specify `https://` node urls, and 
-the certificates used to sign these requests will be verified. To turn off 
-certificate verification, you must specify an `tls` object in the top level 
-config and set `rejectUnauthorized: false`. The default `tls` values are the 
-same that Node.js's https://nodejs.org/api/tls.html#tls_tls_connect_options_callback[`tls.connect()`] 
+Without any additional configuration you can specify `https://` node urls, and
+the certificates used to sign these requests will be verified. To turn off
+certificate verification, you must specify an `tls` object in the top level
+config and set `rejectUnauthorized: false`. The default `tls` values are the
+same that Node.js's https://nodejs.org/api/tls.html#tls_tls_connect_options_callback[`tls.connect()`]
 uses.
 
 [source,js]
@@ -152,7 +152,7 @@ const client = new Client({
 })
 ----
 
-The certificate fingerprint can be calculated using `openssl x509` with the 
+The certificate fingerprint can be calculated using `openssl x509` with the
 certificate file:
 
 [source,sh]
@@ -160,8 +160,8 @@ certificate file:
 openssl x509 -fingerprint -sha256 -noout -in /path/to/http_ca.crt
 ----
 
-If you don't have access to the generated CA file from {es} you can use the 
-following script to output the root CA fingerprint of the {es} instance with 
+If you don't have access to the generated CA file from {es} you can use the
+following script to output the root CA fingerprint of the {es} instance with
 `openssl s_client`:
 
 [source,sh]
@@ -186,8 +186,8 @@ SHA256 Fingerprint=A5:2D:D9:35:11:E8:C6:04:5E:21:F1:66:54:B7:7C:9E:E0:F3:4A:EA:2
 
 WARNING: Running {es} without security enabled is not recommended.
 
-If your cluster is configured with 
-https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html[security explicitly disabled] 
+If your cluster is configured with
+https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html[security explicitly disabled]
 then you can connect via HTTP:
 
 [source,js]
@@ -208,14 +208,14 @@ Following you can find all the supported authentication strategies.
 [[auth-apikey]]
 ==== ApiKey authentication
 
-You can use the 
-{ref-7x}/security-api-create-api-key.html[ApiKey] 
-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 
+You can use the
+{ref-7x}/security-api-create-api-key.html[ApiKey]
+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
 {ref-7x}/security-api-create-api-key.html[create api key endpoint].
 
-NOTE: If you provide both basic authentication credentials and the ApiKey 
+NOTE: If you provide both basic authentication credentials and the ApiKey
 configuration, the ApiKey takes precedence.
 
 [source,js]
@@ -268,10 +268,10 @@ const client = new Client({
 [[auth-basic]]
 ==== Basic authentication
 
-You can provide your credentials by passing the `username` and `password` 
+You can provide your credentials by passing the `username` and `password`
 parameters via the `auth` option.
 
-NOTE: If you provide both basic authentication credentials and the Api Key 
+NOTE: If you provide both basic authentication credentials and the Api Key
 configuration, the Api Key will take precedence.
 
 [source,js]
@@ -342,14 +342,14 @@ const result = await client.search({
 }, { meta: true })
 ----
 
-In this case, the result will be: 
+In this case, the result will be:
 [source,ts]
 ----
 {
   body: object | boolean
   statusCode: number
   headers: object
-  warnings: [string],
+  warnings: string[],
   meta: object
 }
 ----
@@ -361,7 +361,7 @@ NOTE: The body is a boolean value when you use `HEAD` APIs.
 
 If needed, you can abort a running request by using the `AbortController` standard.
 
-CAUTION: If you abort a request, the request will fail with a 
+CAUTION: If you abort a request, the request will fail with a
 `RequestAbortedError`.
 
 
@@ -410,19 +410,23 @@ The supported request specific options are:
 [cols=2*]
 |===
 |`ignore`
-|`[number]` -  HTTP status codes which should not be considered errors for this request. +
+|`number[]` -  HTTP status codes which should not be considered errors for this request. +
 _Default:_ `null`
 
 |`requestTimeout`
-|`number` - Max request timeout for the request in milliseconds, it overrides the client default. +
+|`number | string` - Max request timeout for the request in milliseconds, it overrides the client default. +
 _Default:_ `30000`
 
+|`retryOnTimeout`
+|`boolean` - Retry requests that have timed out.
+_Default:_ `false`
+
 |`maxRetries`
 |`number` - Max number of retries for the request, it overrides the client default. +
 _Default:_ `3`
 
 |`compression`
-|`string, boolean` - Enables body compression for the request. +
+|`string | boolean` - Enables body compression for the request. +
 _Options:_ `false`, `'gzip'` +
 _Default:_ `false`
 
@@ -446,6 +450,10 @@ _Default:_ `null`
 |`any` - Custom object per request. _(you can use it to pass data to the clients events)_ +
 _Default:_ `null`
 
+|`opaqueId`
+|`string` - Set the `X-Opaque-Id` HTTP header. See {ref}/api-conventions.html#x-opaque-id
+_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 +
 _Default:_ `null`
@@ -458,6 +466,17 @@ _Default:_ `null`
 |`AbortSignal` - The AbortSignal instance to allow request abortion. +
 _Default:_ `null`
 
+|`meta`
+|`boolean` - Rather than returning the body, return an object containing `body`, `statusCode`, `headers` and `meta` keys +
+_Default_: `false`
+
+|`redaction`
+|`object` - Options for redacting potentially sensitive data from error metadata. See <<redaction>>.
+
+|`retryBackoff`
+|`(min: number, max: number, attempt: number) => number;` - A function that calculates how long to sleep, in seconds, before the next request retry +
+_Default:_ A built-in function that uses exponential backoff with jitter.
+
 |===
 
 [discrete]
@@ -537,8 +556,8 @@ Resources used to assess these recommendations:
 
 ~Added~ ~in~ ~`v7.10.0`~
 
-If you need to pass through an http(s) proxy for connecting to {es}, the client 
-out of the box offers a handy configuration for helping you with it. Under the 
+If you need to pass through an http(s) proxy for connecting to {es}, the client
+out of the box offers a handy configuration for helping you with it. Under the
 hood, it uses the https://github.com/delvedor/hpagent[`hpagent`] module.
 
 IMPORTANT: In versions 8.0+ of the client, the default `Connection` type is set to `UndiciConnection`, which does not support proxy configurations.
@@ -715,5 +734,5 @@ This pre-flight product check allows the client to establish the version of Elas
 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 
+Once the product check completes, no further product check HTTP requests are sent for
 subsequent API calls.

docs/doc_examples/00272f75a6afea91f8554ef7cda0c1f2.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.security.clearCachedRealms({
+  realms: "default_file,ldap1",
+});
+console.log(response);
+----

docs/doc_examples/004743b9c9f61588926ccf734696b713.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.forcemerge({
+  index: ".ds-my-data-stream-2099.03.07-000001",
+  max_num_segments: 1,
+});
+console.log(response);
+----

docs/doc_examples/004a17b42ab5155bb61da797a006fa9f.asciidoc

@@ -4,20 +4,16 @@
 [source, js]
 ----
 const response = await client.search({
-  index: 'bank',
-  body: {
-    query: {
-      match_all: {}
+  query: {
+    pinned: {
+      ids: ["1", "4", "100"],
+      organic: {
+        match: {
+          description: "iphone",
+        },
+      },
     },
-    sort: [
-      {
-        account_number: 'asc'
-      }
-    ],
-    from: 10,
-    size: 10
-  }
-})
-console.log(response)
+  },
+});
+console.log(response);
 ----
-

docs/doc_examples/006e0e16c9f1da58c0bfe57377f7fc38.asciidoc

@@ -0,0 +1,20 @@
+// 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: "my-index-000001",
+  settings: {
+    analysis: {
+      analyzer: {
+        my_analyzer: {
+          tokenizer: "whitespace",
+          filter: ["stemmer"],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/007179b5e241da650562a5f0a5007823.asciidoc

@@ -0,0 +1,40 @@
+// 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.watcher.putWatch({
+  id: "cluster_health_watch",
+  trigger: {
+    schedule: {
+      interval: "10s",
+    },
+  },
+  input: {
+    http: {
+      request: {
+        host: "localhost",
+        port: 9200,
+        path: "/_cluster/health",
+      },
+    },
+  },
+  condition: {
+    compare: {
+      "ctx.payload.status": {
+        eq: "red",
+      },
+    },
+  },
+  actions: {
+    send_email: {
+      email: {
+        to: "username@example.org",
+        subject: "Cluster Status Warning",
+        body: "Cluster status is RED",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/008ed823c89e703c447ac89c6b689833.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.migration.postFeatureUpgrade();
+console.log(response);
+----

docs/doc_examples/0091fc75271b1fbbd4269622a4881e8b.asciidoc

@@ -4,18 +4,13 @@
 [source, js]
 ----
 const response = await client.search({
-  index: 'bank',
-  body: {
-    query: {
-      match_all: {}
+  index: "my-index",
+  query: {
+    match: {
+      "http.clientip": "40.135.0.0",
     },
-    sort: [
-      {
-        account_number: 'asc'
-      }
-    ]
-  }
-})
-console.log(response)
+  },
+  fields: ["http.clientip"],
+});
+console.log(response);
 ----
-

docs/doc_examples/00ad41bde67beac991534ae0e04b1296.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.getDataStream({
+  name: "my-data-stream",
+  filter_path: "data_streams.indices.index_name",
+});
+console.log(response);
+----

docs/doc_examples/00b3b6d76a368ae71277ea24af318693.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.shardStores();
+console.log(response);
+----

docs/doc_examples/00c05aa931fc985985e3e21c93cf43ff.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.renderSearchTemplate({
+  source: '{ "query": {{#toJson}}my_query{{/toJson}} }',
+  params: {
+    my_query: {
+      match_all: {},
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/00d65f7b9daa1c6b18eedd8ace206bae.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.analyze({
+  tokenizer: "standard",
+  filter: ["asciifolding"],
+  text: "açaí à la carte",
+});
+console.log(response);
+----

docs/doc_examples/00e0c964c79fcc1876ab957da2ffce82.asciidoc

@@ -0,0 +1,67 @@
+// 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: "italian_example",
+  settings: {
+    analysis: {
+      filter: {
+        italian_elision: {
+          type: "elision",
+          articles: [
+            "c",
+            "l",
+            "all",
+            "dall",
+            "dell",
+            "nell",
+            "sull",
+            "coll",
+            "pell",
+            "gl",
+            "agl",
+            "dagl",
+            "degl",
+            "negl",
+            "sugl",
+            "un",
+            "m",
+            "t",
+            "s",
+            "v",
+            "d",
+          ],
+          articles_case: true,
+        },
+        italian_stop: {
+          type: "stop",
+          stopwords: "_italian_",
+        },
+        italian_keywords: {
+          type: "keyword_marker",
+          keywords: ["esempio"],
+        },
+        italian_stemmer: {
+          type: "stemmer",
+          language: "light_italian",
+        },
+      },
+      analyzer: {
+        rebuilt_italian: {
+          tokenizer: "standard",
+          filter: [
+            "italian_elision",
+            "lowercase",
+            "italian_stop",
+            "italian_keywords",
+            "italian_stemmer",
+          ],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/00fea15cbca83be9d5f1a024ff2ec708.asciidoc

@@ -0,0 +1,19 @@
+// 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.inference.put({
+  task_type: "text_embedding",
+  inference_id: "my-e5-model",
+  inference_config: {
+    service: "elasticsearch",
+    service_settings: {
+      num_allocations: 1,
+      num_threads: 1,
+      model_id: ".multilingual-e5-small",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/010d5e901a2690fa7b2396edbe6cd463.asciidoc

@@ -0,0 +1,13 @@
+// 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.putIndexTemplate({
+  name: "my-data-stream-template",
+  index_patterns: ["my-data-stream*"],
+  data_stream: {},
+  priority: 500,
+});
+console.log(response);
+----

docs/doc_examples/015e6e6132b6d6d44bddb06bc3b316ed.asciidoc

@@ -0,0 +1,46 @@
+// 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.search({
+  index: "retrievers_example",
+  retriever: {
+    rrf: {
+      retrievers: [
+        {
+          standard: {
+            query: {
+              range: {
+                year: {
+                  gt: 2023,
+                },
+              },
+            },
+          },
+        },
+        {
+          standard: {
+            query: {
+              term: {
+                topic: "elastic",
+              },
+            },
+          },
+        },
+      ],
+      rank_window_size: 10,
+      rank_constant: 1,
+    },
+  },
+  _source: false,
+  aggs: {
+    topics: {
+      terms: {
+        field: "topic",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0163af36c8472ac0c5160c8b716f5b26.asciidoc

@@ -0,0 +1,24 @@
+// 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.search({
+  index: "sales",
+  size: 0,
+  filter_path: "aggregations",
+  query: {
+    term: {
+      type: "t-shirt",
+    },
+  },
+  aggs: {
+    avg_price: {
+      avg: {
+        field: "price",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0165d22da5f2fc7678392b31d8eb5566.asciidoc

@@ -0,0 +1,18 @@
+// 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.inference.put({
+  task_type: "rerank",
+  inference_id: "my-rerank-model",
+  inference_config: {
+    service: "cohere",
+    service_settings: {
+      model_id: "rerank-english-v3.0",
+      api_key: "{{COHERE_API_KEY}}",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/016f3147dae9ff2c3e831257ae470361.asciidoc

@@ -4,17 +4,14 @@
 [source, js]
 ----
 const response = await client.indices.updateAliases({
-  body: {
-    actions: [
-      {
-        add: {
-          index: 'test1',
-          alias: 'alias1'
-        }
-      }
-    ]
-  }
-})
-console.log(response)
+  actions: [
+    {
+      add: {
+        index: "logs-*",
+        alias: "logs",
+      },
+    },
+  ],
+});
+console.log(response);
 ----
-

docs/doc_examples/019e329ed5a930aef825266822e7377a.asciidoc

@@ -0,0 +1,26 @@
+// 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: "asciifold_example",
+  settings: {
+    analysis: {
+      analyzer: {
+        standard_asciifolding: {
+          tokenizer: "standard",
+          filter: ["my_ascii_folding"],
+        },
+      },
+      filter: {
+        my_ascii_folding: {
+          type: "asciifolding",
+          preserve_original: true,
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/01ae196538fac197eedbbf458a4ef31b.asciidoc

@@ -0,0 +1,36 @@
+// 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: "idx",
+  settings: {
+    index: {
+      mapping: {
+        source: {
+          mode: "synthetic",
+        },
+      },
+    },
+  },
+  mappings: {
+    properties: {
+      kwd: {
+        type: "keyword",
+        ignore_above: 3,
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.index({
+  index: "idx",
+  id: 1,
+  document: {
+    kwd: ["foo", "foo", "bang", "bar", "baz"],
+  },
+});
+console.log(response1);
+----

docs/doc_examples/01b23f09d2b7f140faf649eadbbf3ac3.asciidoc

@@ -0,0 +1,37 @@
+// 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.cluster.putComponentTemplate({
+  name: "component_template1",
+  template: {
+    mappings: {
+      properties: {
+        "@timestamp": {
+          type: "date",
+        },
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.cluster.putComponentTemplate({
+  name: "runtime_component_template",
+  template: {
+    mappings: {
+      runtime: {
+        day_of_week: {
+          type: "keyword",
+          script: {
+            source:
+              "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))",
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response1);
+----

docs/doc_examples/01bc0f2ed30eb3dd23511d01ce0ac6e1.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.transform.startTransform({
+  transform_id: "ecommerce_transform",
+});
+console.log(response);
+----

docs/doc_examples/01cd0ea360282a2c591a366679d7187d.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.tasks.list({
+  human: "true",
+  detailed: "true",
+  actions: "indices:data/write/bulk",
+});
+console.log(response);
+----

docs/doc_examples/01da9e0620e48270617fc248e6415cac.asciidoc

@@ -4,18 +4,14 @@
 [source, js]
 ----
 const response = await client.search({
-  body: {
-    query: {
+  index: "my-index-000001",
+  aggs: {
+    "my-agg-name": {
       terms: {
-        user: [
-          'kimchy',
-          'elasticsearch'
-        ],
-        boost: 1
-      }
-    }
-  }
-})
-console.log(response)
+        field: "my-field",
+      },
+    },
+  },
+});
+console.log(response);
 ----
-

docs/doc_examples/01dc7bdc223bd651574ed2d3954a5b1c.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.watcher.executeWatch({
+  id: "my_watch",
+});
+console.log(response);
+----

docs/doc_examples/01f50acf7998b24969f451e922d145eb.asciidoc

@@ -0,0 +1,39 @@
+// 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: "basque_example",
+  settings: {
+    analysis: {
+      filter: {
+        basque_stop: {
+          type: "stop",
+          stopwords: "_basque_",
+        },
+        basque_keywords: {
+          type: "keyword_marker",
+          keywords: ["Adibidez"],
+        },
+        basque_stemmer: {
+          type: "stemmer",
+          language: "basque",
+        },
+      },
+      analyzer: {
+        rebuilt_basque: {
+          tokenizer: "standard",
+          filter: [
+            "lowercase",
+            "basque_stop",
+            "basque_keywords",
+            "basque_stemmer",
+          ],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/020c95db88ef356093f03be84893ddf9.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.ccr.followStats({
+  index: "<index>",
+});
+console.log(response);
+----

docs/doc_examples/020de6b6cb960a76297452725a38889f.asciidoc

@@ -0,0 +1,20 @@
+// 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.search({
+  query: {
+    has_child: {
+      type: "child",
+      query: {
+        match_all: {},
+      },
+      max_children: 10,
+      min_children: 2,
+      score_mode: "min",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0246f73cc2ed3dfec577119e8cd15404.asciidoc

@@ -0,0 +1,19 @@
+// 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.putMapping({
+  index: "my-index-000001",
+  properties: {
+    name: {
+      properties: {
+        last: {
+          type: "text",
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/025155da86802ebf4c3aeee5aab692f9.asciidoc

@@ -0,0 +1,28 @@
+// 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: "sales",
+  mappings: {
+    properties: {
+      tags: {
+        type: "keyword",
+      },
+      comments: {
+        type: "nested",
+        properties: {
+          username: {
+            type: "keyword",
+          },
+          comment: {
+            type: "text",
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/02520ac7816b2c4cf8fb413fd16122f2.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.ml.flushJob({
+  job_id: "low_request_rate",
+  calc_interim: true,
+});
+console.log(response);
+----

docs/doc_examples/0264e994a7e68561e2ca6be0f0d90ee9.asciidoc

@@ -0,0 +1,23 @@
+// 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.search({
+  aggs: {
+    JapaneseCars: {
+      terms: {
+        field: "make",
+        include: ["mazda", "honda"],
+      },
+    },
+    ActiveCarManufacturers: {
+      terms: {
+        field: "make",
+        exclude: ["rover", "jensen"],
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0280247e0cf2e561c548f22c9fb31163.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.security.invalidateToken({
+  username: "myuser",
+});
+console.log(response);
+----

docs/doc_examples/02853293a5b7cd9cc7a886eb413bbeb6.asciidoc

@@ -0,0 +1,28 @@
+// 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.analyze({
+  tokenizer: "keyword",
+  char_filter: [
+    {
+      type: "mapping",
+      mappings: [
+        "٠ => 0",
+        "١ => 1",
+        "٢ => 2",
+        "٣ => 3",
+        "٤ => 4",
+        "٥ => 5",
+        "٦ => 6",
+        "٧ => 7",
+        "٨ => 8",
+        "٩ => 9",
+      ],
+    },
+  ],
+  text: "My license plate is ٢٥٠١٥",
+});
+console.log(response);
+----

docs/doc_examples/028f6d6ac2594e20b78b8a8f8cbad49d.asciidoc

@@ -1,43 +0,0 @@
-// 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.search({
-  body: {
-    aggs: {
-      countries: {
-        terms: {
-          field: 'artist.country',
-          order: [
-            {
-              'rock>playback_stats.avg': 'desc'
-            },
-            {
-              _count: 'desc'
-            }
-          ]
-        },
-        aggs: {
-          rock: {
-            filter: {
-              term: {
-                genre: 'rock'
-              }
-            },
-            aggs: {
-              playback_stats: {
-                stats: {
-                  field: 'play_count'
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-})
-console.log(response)
-----
-

docs/doc_examples/029de2f5383a42e1ac4ca1565bd2a130.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: "my-index-000001",
+  mappings: {
+    properties: {
+      full_name: {
+        type: "text",
+        index_prefixes: {
+          min_chars: 1,
+          max_chars: 10,
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/02b00f21e9d23d82276ace0dd154d779.asciidoc

@@ -0,0 +1,16 @@
+// 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.search({
+  index: "my-index-000001",
+  routing: "user1,user2",
+  query: {
+    match: {
+      title: "document",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/02b6aa3e5652839f03de3a655854b897.asciidoc

@@ -4,9 +4,7 @@
 [source, js]
 ----
 const response = await client.search({
-  index: '*',
-  q: 'user:kimchy'
-})
-console.log(response)
+  index: "my-data-stream",
+});
+console.log(response);
 ----
-

docs/doc_examples/02c48d461536709c3fc8a0e8147c3787.asciidoc

@@ -0,0 +1,24 @@
+// 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.ingest.putPipeline({
+  id: "pipelineB",
+  description: "outer pipeline",
+  processors: [
+    {
+      pipeline: {
+        name: "pipelineA",
+      },
+    },
+    {
+      set: {
+        field: "outer_pipeline_set",
+        value: "outer",
+      },
+    },
+  ],
+});
+console.log(response);
+----

docs/doc_examples/02f65c6bab8f40bf3ce18160623d1870.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.getTemplate({
+  name: "template_1",
+});
+console.log(response);
+----

docs/doc_examples/02fad6b80bb29c2a7e6840db2fc67b18.asciidoc

@@ -0,0 +1,38 @@
+// 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: "my-index-000001",
+  mappings: {
+    properties: {
+      my_wildcard: {
+        type: "wildcard",
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.index({
+  index: "my-index-000001",
+  id: 1,
+  document: {
+    my_wildcard: "This string can be quite lengthy",
+  },
+});
+console.log(response1);
+
+const response2 = await client.search({
+  index: "my-index-000001",
+  query: {
+    wildcard: {
+      my_wildcard: {
+        value: "*quite*lengthy",
+      },
+    },
+  },
+});
+console.log(response2);
+----

docs/doc_examples/0308cbd85281f95fc458042afe3f587d.asciidoc

@@ -4,10 +4,9 @@
 [source, js]
 ----
 const response = await client.get({
-  index: 'twitter',
-  id: '2',
-  routing: 'user1'
-})
-console.log(response)
+  index: "my-index-000001",
+  id: 0,
+  _source: "*.id",
+});
+console.log(response);
 ----
-

docs/doc_examples/032eac56b798bea29390e102538f4a26.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.refresh({
+  index: "my-index-000001,my-index-000002",
+});
+console.log(response);
+----

docs/doc_examples/033778305d52746f5ce0a2a922c8e521.asciidoc

@@ -1,22 +0,0 @@
-// 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.search({
-  body: {
-    aggs: {
-      genres: {
-        terms: {
-          script: {
-            source: "doc['genre'].value",
-            lang: 'painless'
-          }
-        }
-      }
-    }
-  }
-})
-console.log(response)
-----
-

docs/doc_examples/033838729cfb5d1a28d04f69ee78d924.asciidoc

@@ -0,0 +1,26 @@
+// 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.index({
+  index: "example",
+  document: {
+    location: {
+      type: "Polygon",
+      orientation: "LEFT",
+      coordinates: [
+        [
+          [-177, 10],
+          [176, 15],
+          [172, 0],
+          [176, -15],
+          [-177, -10],
+          [-177, 10],
+        ],
+      ],
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0350410d11579f4e876c798ce1eaef5b.asciidoc

@@ -0,0 +1,36 @@
+// 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.index({
+  index: "my-index-000001",
+  id: 5,
+  refresh: "true",
+  document: {
+    query: {
+      bool: {
+        should: [
+          {
+            match: {
+              message: {
+                query: "Japanese art",
+                _name: "query1",
+              },
+            },
+          },
+          {
+            match: {
+              message: {
+                query: "Holand culture",
+                _name: "query2",
+              },
+            },
+          },
+        ],
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0350ff5ebb8207c004eb771088339cb4.asciidoc

@@ -0,0 +1,38 @@
+// 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.search({
+  index: "example-index",
+  retriever: {
+    rrf: {
+      retrievers: [
+        {
+          standard: {
+            query: {
+              term: {
+                text: "blue shoes sale",
+              },
+            },
+          },
+        },
+        {
+          standard: {
+            query: {
+              sparse_vector: {
+                field: "ml.tokens",
+                inference_id: "my_elser_model",
+                query: "What blue shoes are on sale?",
+              },
+            },
+          },
+        },
+      ],
+      rank_window_size: 50,
+      rank_constant: 20,
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/03582fc93683e573062bcfda45e01d69.asciidoc

@@ -0,0 +1,29 @@
+// 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: "my-index-000001",
+  settings: {
+    analysis: {
+      analyzer: {
+        my_custom_analyzer: {
+          type: "custom",
+          tokenizer: "standard",
+          char_filter: ["html_strip"],
+          filter: ["lowercase", "asciifolding"],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.indices.analyze({
+  index: "my-index-000001",
+  analyzer: "my_custom_analyzer",
+  text: "Is this déjà vu</b>?",
+});
+console.log(response1);
+----

docs/doc_examples/035a7a919eb6513b4769a3727b7d6447.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.analyze({
+  analyzer: "whitespace",
+  text: "The quick brown fox.",
+});
+console.log(response);
+----

docs/doc_examples/03891265df2111a38e0b6b24c1b967e1.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.security.getServiceAccounts();
+console.log(response);
+----

docs/doc_examples/03b1d76fa0b773d5b7d74ecb7e1e1a80.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.snapshot.restore({
+  repository: "my_repository",
+  snapshot: "my_snapshot_2099.05.06",
+  indices: "my-index,logs-my_app-default",
+  rename_pattern: "(.+)",
+  rename_replacement: "restored-$1",
+});
+console.log(response);
+----

docs/doc_examples/03c4b815bf1e6a8c5cfcc6ddf94bc093.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.sql.query({
+  format: "txt",
+  query: "SELECT * FROM library ORDER BY page_count DESC LIMIT 5",
+});
+console.log(response);
+----

docs/doc_examples/04412d11783dac25b5fd2ec5407078a3.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.connector.updateApiKeyId({
+  connector_id: "my-connector",
+  api_key_id: "my-api-key-id",
+  api_key_secret_id: "my-connector-secret-id",
+});
+console.log(response);
+----

docs/doc_examples/044b2f99e7438e408685b258db17f863.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.eql.search({
+  index: "my-data-stream",
+  query: '\n    process where process.name == "regsvr32.exe"\n  ',
+  size: 50,
+});
+console.log(response);
+----

docs/doc_examples/046b2249bbc49e77848c114cee940f17.asciidoc

@@ -0,0 +1,52 @@
+// 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.search({
+  index: "my-index",
+  retriever: {
+    rrf: {
+      retrievers: [
+        {
+          standard: {
+            query: {
+              multi_match: {
+                query: "How is the weather in Jamaica?",
+                fields: ["title", "description"],
+              },
+            },
+          },
+        },
+        {
+          standard: {
+            query: {
+              text_expansion: {
+                "ml.inference.title_expanded.predicted_value": {
+                  model_id: ".elser_model_2",
+                  model_text: "How is the weather in Jamaica?",
+                },
+              },
+            },
+          },
+        },
+        {
+          standard: {
+            query: {
+              text_expansion: {
+                "ml.inference.description_expanded.predicted_value": {
+                  model_id: ".elser_model_2",
+                  model_text: "How is the weather in Jamaica?",
+                },
+              },
+            },
+          },
+        },
+      ],
+      window_size: 10,
+      rank_constant: 20,
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0470d7101637568b9d3d1239f06325a7.asciidoc

@@ -0,0 +1,27 @@
+// 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.transport.request({
+  method: "PUT",
+  path: "/_internal/desired_nodes/<history_id>/<version>",
+  body: {
+    nodes: [
+      {
+        settings: {
+          "node.name": "instance-000187",
+          "node.external_id": "instance-000187",
+          "node.roles": ["data_hot", "master"],
+          "node.attr.data": "hot",
+          "node.attr.logical_availability_zone": "zone-0",
+        },
+        processors: 8,
+        memory: "58gb",
+        storage: "2tb",
+      },
+    ],
+  },
+});
+console.log(response);
+----

docs/doc_examples/047266b0d20fdb62ebc72d51952c8f6d.asciidoc

@@ -4,20 +4,14 @@
 [source, js]
 ----
 const response = await client.search({
-  body: {
-    query: {
-      multi_match: {
-        query: 'Will Smith',
-        type: 'cross_fields',
-        fields: [
-          'first_name',
-          'last_name'
-        ],
-        operator: 'and'
-      }
-    }
-  }
-})
-console.log(response)
+  query: {
+    multi_match: {
+      query: "Will Smith",
+      type: "cross_fields",
+      fields: ["first_name", "last_name"],
+      operator: "and",
+    },
+  },
+});
+console.log(response);
 ----
-

docs/doc_examples/048652b6abfe195da8ea8cef10ee01b1.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.transform.resetTransform({
+  transform_id: "ecommerce_transform",
+});
+console.log(response);
+----

docs/doc_examples/048d8abd42d094bbdcf4452a58ccb35b.asciidoc

@@ -1,17 +0,0 @@
-// 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.create({
-  index: 'twitter',
-  id: '1',
-  body: {
-    user: 'kimchy',
-    post_date: '2009-11-15T14:12:12',
-    message: 'trying out Elasticsearch'
-  }
-})
-console.log(response)
-----
-

docs/doc_examples/04d586a536061ec1045d0bb2dc3d1a5f.asciidoc

@@ -0,0 +1,31 @@
+// 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.ingest.putPipeline({
+  id: "set_os",
+  description: "sets the value of host.os.name from the field os",
+  processors: [
+    {
+      set: {
+        field: "host.os.name",
+        value: "{{{os}}}",
+      },
+    },
+  ],
+});
+console.log(response);
+
+const response1 = await client.ingest.simulate({
+  id: "set_os",
+  docs: [
+    {
+      _source: {
+        os: "Ubuntu",
+      },
+    },
+  ],
+});
+console.log(response1);
+----

docs/doc_examples/04d6ce0c903bd468afbecd3aa1c4a78a.asciidoc

@@ -0,0 +1,27 @@
+// 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.ingest.putPipeline({
+  id: "my-pipeline-id",
+  description: "My optional pipeline description",
+  processors: [
+    {
+      set: {
+        description: "My optional processor description",
+        field: "my-keyword-field",
+        value: "foo",
+      },
+    },
+  ],
+  _meta: {
+    reason: "set my-keyword-field to foo",
+    serialization: {
+      class: "MyPipeline",
+      id: 10,
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/04de2e3a9c00c2056b07bf9cf9e63a99.asciidoc

@@ -0,0 +1,20 @@
+// 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.inference.put({
+  task_type: "text_embedding",
+  inference_id: "google_vertex_ai_embeddings",
+  inference_config: {
+    service: "googlevertexai",
+    service_settings: {
+      service_account_json: "<service_account_json>",
+      model_id: "<model_id>",
+      location: "<location>",
+      project_id: "<project_id>",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/04f5dd677c777bcb15d7d5fa63275fc8.asciidoc

@@ -4,9 +4,8 @@
 [source, js]
 ----
 const response = await client.cluster.health({
-  wait_for_status: 'yellow',
-  timeout: '50s'
-})
-console.log(response)
+  wait_for_status: "yellow",
+  timeout: "50s",
+});
+console.log(response);
 ----
-

docs/doc_examples/04fe1e3a0047b0cdb10987b79fc3f3f3.asciidoc

@@ -1,30 +0,0 @@
-// 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.search({
-  body: {
-    query: {
-      term: {
-        user: 'kimchy'
-      }
-    },
-    sort: {
-      _script: {
-        type: 'number',
-        script: {
-          lang: 'painless',
-          source: "doc['field_name'].value * params.factor",
-          params: {
-            factor: 1.1
-          }
-        },
-        order: 'asc'
-      }
-    }
-  }
-})
-console.log(response)
-----
-

docs/doc_examples/0502284d4685c478eb68761f979f4303.asciidoc

@@ -0,0 +1,37 @@
+// 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.ml.evaluateDataFrame({
+  index: "house_price_predictions",
+  query: {
+    bool: {
+      filter: [
+        {
+          term: {
+            "ml.is_training": false,
+          },
+        },
+      ],
+    },
+  },
+  evaluation: {
+    regression: {
+      actual_field: "price",
+      predicted_field: "ml.price_prediction",
+      metrics: {
+        r_squared: {},
+        mse: {},
+        msle: {
+          offset: 10,
+        },
+        huber: {
+          delta: 1.5,
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/050b3947025fee403232b8e6e9112dab.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.sql.query({
+  format: "yaml",
+  query: "SELECT * FROM library ORDER BY page_count DESC",
+  fetch_size: 5,
+});
+console.log(response);
+----

docs/doc_examples/05148cc541f447486d9daf15ab77292b.asciidoc

@@ -0,0 +1,54 @@
+// 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.ilm.putLifecycle({
+  name: "logs",
+  policy: {
+    phases: {
+      hot: {
+        actions: {
+          rollover: {
+            max_primary_shard_size: "50gb",
+          },
+        },
+      },
+      warm: {
+        min_age: "30d",
+        actions: {
+          shrink: {
+            number_of_shards: 1,
+          },
+          forcemerge: {
+            max_num_segments: 1,
+          },
+        },
+      },
+      cold: {
+        min_age: "60d",
+        actions: {
+          searchable_snapshot: {
+            snapshot_repository: "found-snapshots",
+          },
+        },
+      },
+      frozen: {
+        min_age: "90d",
+        actions: {
+          searchable_snapshot: {
+            snapshot_repository: "found-snapshots",
+          },
+        },
+      },
+      delete: {
+        min_age: "735d",
+        actions: {
+          delete: {},
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/0518c673094fb18ecb491a3b78af4695.asciidoc

@@ -0,0 +1,23 @@
+// 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.ilm.putLifecycle({
+  name: "my_policy",
+  policy: {
+    phases: {
+      warm: {
+        actions: {
+          allocate: {
+            include: {
+              box_type: "hot,warm",
+            },
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/05284c8ea91769c09c8db47db8a6629a.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.cat.repositories({
+  v: "true",
+});
+console.log(response);
+----

docs/doc_examples/053497b6960f80fd7b005b7c6d54358f.asciidoc

@@ -0,0 +1,19 @@
+// 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.ilm.putLifecycle({
+  name: "my_policy",
+  policy: {
+    phases: {
+      delete: {
+        actions: {
+          delete: {},
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/05500e77aef581d92f6c605f7a48f7df.asciidoc

@@ -0,0 +1,24 @@
+// 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.index({
+  index: "example",
+  document: {
+    location: {
+      type: "polygon",
+      coordinates: [
+        [
+          [1000, -1001],
+          [1001, -1001],
+          [1001, -1000],
+          [1000, -1000],
+          [1000, -1001],
+        ],
+      ],
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/059e04aaf093379401f665c33ac796dc.asciidoc

@@ -0,0 +1,20 @@
+// 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.analyze({
+  tokenizer: "whitespace",
+  filter: [
+    {
+      type: "keyword_marker",
+      keywords: ["jumping"],
+    },
+    "stemmer",
+  ],
+  text: "fox running and jumping",
+  explain: true,
+  attributes: "keyword",
+});
+console.log(response);
+----

docs/doc_examples/05a09078fe1016e900e445ad4039cf97.asciidoc

@@ -0,0 +1,78 @@
+// 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: "clientips",
+  mappings: {
+    properties: {
+      client_ip: {
+        type: "keyword",
+      },
+      env: {
+        type: "keyword",
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.bulk({
+  index: "clientips",
+  operations: [
+    {
+      index: {},
+    },
+    {
+      client_ip: "172.21.0.5",
+      env: "Development",
+    },
+    {
+      index: {},
+    },
+    {
+      client_ip: "172.21.2.113",
+      env: "QA",
+    },
+    {
+      index: {},
+    },
+    {
+      client_ip: "172.21.2.162",
+      env: "QA",
+    },
+    {
+      index: {},
+    },
+    {
+      client_ip: "172.21.3.15",
+      env: "Production",
+    },
+    {
+      index: {},
+    },
+    {
+      client_ip: "172.21.3.16",
+      env: "Production",
+    },
+  ],
+});
+console.log(response1);
+
+const response2 = await client.enrich.putPolicy({
+  name: "clientip_policy",
+  match: {
+    indices: "clientips",
+    match_field: "client_ip",
+    enrich_fields: ["env"],
+  },
+});
+console.log(response2);
+
+const response3 = await client.enrich.executePolicy({
+  name: "clientip_policy",
+  wait_for_completion: "false",
+});
+console.log(response3);
+----