Auto-generated API code (#2886)

(cherry picked from commit b030084f24)

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

.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.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"
@@ -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

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

.github/make.sh

@@ -65,7 +65,7 @@ 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
+    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

.github/workflows/nodejs.yml

@@ -11,10 +11,10 @@ jobs:
     outputs:
       src-only: "${{ steps.changes.outputs.src-only }}"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
           persist-credentials: false
-      - uses: dorny/paths-filter/@v3.0.2
+      - uses: dorny/paths-filter/@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
         id: changes
         with:
           filters: |
@@ -36,12 +36,12 @@ jobs:
         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 }}
 
@@ -66,12 +66,12 @@ jobs:
     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
 
@@ -96,12 +96,12 @@ jobs:
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
           persist-credentials: false
 
       - name: Use Bun
-        uses: oven-sh/setup-bun@v2
+        uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2
 
       - name: Install
         run: |
@@ -118,13 +118,3 @@ jobs:
       - name: ECMAScript module test
         run: |
           bun run test:esm
-
-  auto-approve:
-    name: Auto-approve
-    needs: [test, license]
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-    if: github.actor == 'elasticmachine'
-    steps:
-      - uses: hmarr/auto-approve-action@v4

.github/workflows/npm-publish.yml

@@ -12,11 +12,11 @@ jobs:
       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@v4
+      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
         with:
           node-version: "22.x"
           registry-url: "https://registry.npmjs.org"

.github/workflows/serverless-patch.yml

@@ -26,14 +26,14 @@ 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
@@ -42,7 +42,7 @@ jobs:
       - 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

.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

@@ -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

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
 }

docs/changelog.asciidoc

@@ -1,6 +1,60 @@
 [[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
 

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/0722b302b2b3275a988d858044f99d5d.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.getMapping({
+  index: "kibana_sample_data_ecommerce",
+});
+console.log(response);
+----

docs/doc_examples/074e4602d1ca54412380a40867d078bc.asciidoc

@@ -11,6 +11,8 @@ const response = await client.indices.putSettings({
     "index.indexing.slowlog.threshold.index.debug": "2s",
     "index.indexing.slowlog.threshold.index.trace": "500ms",
     "index.indexing.slowlog.source": "1000",
+    "index.indexing.slowlog.reformat": true,
+    "index.indexing.slowlog.include.user": true,
   },
 });
 console.log(response);

docs/doc_examples/082e78c7a2061a7c4a52b494e5ede0e8.asciidoc

@@ -0,0 +1,42 @@
+// 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-rank-vectors-bit",
+  mappings: {
+    properties: {
+      my_vector: {
+        type: "rank_vectors",
+        element_type: "bit",
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.bulk({
+  index: "my-rank-vectors-bit",
+  refresh: "true",
+  operations: [
+    {
+      index: {
+        _id: "1",
+      },
+    },
+    {
+      my_vector: [127, -127, 0, 1, 42],
+    },
+    {
+      index: {
+        _id: "2",
+      },
+    },
+    {
+      my_vector: "8100012a7f",
+    },
+  ],
+});
+console.log(response1);
+----

docs/doc_examples/0f028f71f04c1d569fab402869565a84.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.putSettings({
+  index: ".reindexed-v9-ml-anomalies-custom-example",
+  settings: {
+    index: {
+      number_of_replicas: "<original_number_of_replicas>",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/120fcf9f55128d6a81d5e87a9c235bbd.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.transport.request({
+  method: "POST",
+  path: "/_inference/chat_completion/openai-completion/_stream",
+  body: {
+    model: "gpt-4o",
+    messages: [
+      {
+        role: "user",
+        content: "What is Elastic?",
+      },
+    ],
+  },
+});
+console.log(response);
+----

docs/doc_examples/12adea5d76f73d94d80d42f53f67563f.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.addBlock({
+  index: ".ml-anomalies-custom-example",
+  block: "read_only",
+});
+console.log(response);
+----

docs/doc_examples/141ef0ebaa3b0772892b79b9bb85efb0.asciidoc

@@ -3,11 +3,13 @@
 
 [source, js]
 ----
-const response = await client.inference.inference({
+const response = await client.inference.put({
   task_type: "my-inference-endpoint",
   inference_id: "_update",
-  service_settings: {
-    api_key: "<API_KEY>",
+  inference_config: {
+    service_settings: {
+      api_key: "<API_KEY>",
+    },
   },
 });
 console.log(response);

docs/doc_examples/1ead35c954963e83f89872048dabdbe9.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.security.queryRole({
+  query: {
+    bool: {
+      must_not: {
+        term: {
+          "metadata._reserved": true,
+        },
+      },
+    },
+  },
+  sort: ["name"],
+});
+console.log(response);
+----

docs/doc_examples/246763219ec06172f7aa57bba28d344a.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: "my-rank-vectors-bit",
+  mappings: {
+    properties: {
+      my_vector: {
+        type: "rank_vectors",
+        element_type: "bit",
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.bulk({
+  index: "my-rank-vectors-bit",
+  refresh: "true",
+  operations: [
+    {
+      index: {
+        _id: "1",
+      },
+    },
+    {
+      my_vector: [127, -127, 0, 1, 42],
+    },
+    {
+      index: {
+        _id: "2",
+      },
+    },
+    {
+      my_vector: "8100012a7f",
+    },
+  ],
+});
+console.log(response1);
+
+const response2 = await client.search({
+  index: "my-rank-vectors-bit",
+  query: {
+    script_score: {
+      query: {
+        match_all: {},
+      },
+      script: {
+        source: "maxSimDotProduct(params.query_vector, 'my_vector')",
+        params: {
+          query_vector: [
+            [
+              0.35, 0.77, 0.95, 0.15, 0.11, 0.08, 0.58, 0.06, 0.44, 0.52, 0.21,
+              0.62, 0.65, 0.16, 0.64, 0.39, 0.93, 0.06, 0.93, 0.31, 0.92, 0,
+              0.66, 0.86, 0.92, 0.03, 0.81, 0.31, 0.2, 0.92, 0.95, 0.64, 0.19,
+              0.26, 0.77, 0.64, 0.78, 0.32, 0.97, 0.84,
+            ],
+          ],
+        },
+      },
+    },
+  },
+});
+console.log(response2);
+----

docs/doc_examples/272e27bf1fcc4fe5dbd4092679dd0342.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.addBlock({
+  index: ".ml-anomalies-custom-example",
+  block: "write",
+});
+console.log(response);
+----

docs/doc_examples/2a21674c40f9b182a8944769d20b2357.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.search({
+  index: "my-rank-vectors-float",
+  query: {
+    script_score: {
+      query: {
+        match_all: {},
+      },
+      script: {
+        source: "maxSimDotProduct(params.query_vector, 'my_vector')",
+        params: {
+          query_vector: [
+            [0.5, 10, 6],
+            [-0.5, 10, 10],
+          ],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/2afd49985950cbcccf727fa858d00067.asciidoc

@@ -6,13 +6,13 @@
 const response = await client.indices.create({
   index: "test-index",
   query: {
-    semantic: {
-      field: "my_semantic_field",
+    match: {
+      my_field: "Which country is Paris in?",
     },
   },
   highlight: {
     fields: {
-      my_semantic_field: {
+      my_field: {
         type: "semantic",
         number_of_fragments: 2,
         order: "score",

docs/doc_examples/2f72a63c73dd672ac2dc3997ad15dd41.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.indices.create({
+  index: "test-index",
+  mappings: {
+    properties: {
+      source_field: {
+        type: "text",
+        fields: {
+          infer_field: {
+            type: "semantic_text",
+            inference_id: ".elser-2-elasticsearch",
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/31832bd71c31c46a1ccf8d1c210d89d4.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.search({
+  index: "my-index-*",
+  query: {
+    bool: {
+      must: [
+        {
+          match: {
+            "user.id": "kimchy",
+          },
+        },
+      ],
+      must_not: [
+        {
+          terms: {
+            _index: ["my-index-01"],
+          },
+        },
+      ],
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/32c8c86702ccd68eb70f1573409c2a1f.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.ilm.putLifecycle({
+  name: "my_policy",
+  policy: {
+    phases: {
+      hot: {
+        actions: {
+          rollover: {
+            max_primary_shard_size: "50gb",
+          },
+          searchable_snapshot: {
+            snapshot_repository: "backing_repo",
+            replicate_for: "14d",
+          },
+        },
+      },
+      delete: {
+        min_age: "28d",
+        actions: {
+          delete: {},
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/3312c82f81816bf76629db9582991812.asciidoc

@@ -14,6 +14,7 @@ const response = await client.indices.putSettings({
     "index.search.slowlog.threshold.fetch.info": "800ms",
     "index.search.slowlog.threshold.fetch.debug": "500ms",
     "index.search.slowlog.threshold.fetch.trace": "200ms",
+    "index.search.slowlog.include.user": true,
   },
 });
 console.log(response);

docs/doc_examples/36792c81c053e0555407d1e83e7e054f.asciidoc

@@ -0,0 +1,70 @@
+// 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: "movies",
+  size: 10,
+  retriever: {
+    rescorer: {
+      rescore: {
+        window_size: 50,
+        query: {
+          rescore_query: {
+            script_score: {
+              query: {
+                match_all: {},
+              },
+              script: {
+                source:
+                  "cosineSimilarity(params.queryVector, 'product-vector_final_stage') + 1.0",
+                params: {
+                  queryVector: [-0.5, 90, -10, 14.8, -156],
+                },
+              },
+            },
+          },
+        },
+      },
+      retriever: {
+        rrf: {
+          rank_window_size: 100,
+          retrievers: [
+            {
+              standard: {
+                query: {
+                  sparse_vector: {
+                    field: "plot_embedding",
+                    inference_id: "my-elser-model",
+                    query: "films that explore psychological depths",
+                  },
+                },
+              },
+            },
+            {
+              standard: {
+                query: {
+                  multi_match: {
+                    query: "crime",
+                    fields: ["plot", "title"],
+                  },
+                },
+              },
+            },
+            {
+              knn: {
+                field: "vector",
+                query_vector: [10, 22, 77],
+                k: 10,
+                num_candidates: 10,
+              },
+            },
+          ],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/3722dad876023e0757138dd5a6d3240e.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.indices.create({
+  index: "my-index",
+  settings: {
+    index: {
+      number_of_shards: 3,
+      "blocks.write": true,
+    },
+  },
+  mappings: {
+    properties: {
+      field1: {
+        type: "text",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/38ba93890494bfa7beece58dffa44f98.asciidoc

@@ -1,23 +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.bulk({
-  index: "test-index",
-  operations: [
-    {
-      update: {
-        _id: "1",
-      },
-    },
-    {
-      doc: {
-        infer_field: "updated inference field",
-        source_field: "updated source field",
-      },
-    },
-  ],
-});
-console.log(response);
-----

docs/doc_examples/3a204b57072a104d9b50f3a9e064a8f6.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.search({
+  index: ".ml-anomalies-custom-example",
+  size: 0,
+  aggs: {
+    job_ids: {
+      terms: {
+        field: "job_id",
+        size: 100,
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/3bc4a3681e3ea9cb3de49f72085807d8.asciidoc

@@ -0,0 +1,61 @@
+// 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: {
+    linear: {
+      retrievers: [
+        {
+          retriever: {
+            standard: {
+              query: {
+                function_score: {
+                  query: {
+                    term: {
+                      topic: "ai",
+                    },
+                  },
+                  functions: [
+                    {
+                      script_score: {
+                        script: {
+                          source: "doc['timestamp'].value.millis",
+                        },
+                      },
+                    },
+                  ],
+                  boost_mode: "replace",
+                },
+              },
+              sort: {
+                timestamp: {
+                  order: "asc",
+                },
+              },
+            },
+          },
+          weight: 2,
+          normalizer: "minmax",
+        },
+        {
+          retriever: {
+            knn: {
+              field: "vector",
+              query_vector: [0.23, 0.67, 0.89],
+              k: 3,
+              num_candidates: 5,
+            },
+          },
+          weight: 1.5,
+        },
+      ],
+      rank_window_size: 10,
+    },
+  },
+  _source: false,
+});
+console.log(response);
+----

docs/doc_examples/3ea4c971b3f47735dcc207ee2645fa03.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.indices.updateAliases({
+  actions: [
+    {
+      remove_index: {
+        index: "my-index-2099.05.06-000001",
+      },
+    },
+  ],
+});
+console.log(response);
+----

docs/doc_examples/3f9dcf2aa42f3ecfb5ebfe48c1774103.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.search({
+  index: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    order_stats: {
+      stats: {
+        field: "taxful_total_price",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/41d24383d29b2808a65258a0a3256e96.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.indices.create({
+  index: "jinaai-index",
+  mappings: {
+    properties: {
+      content: {
+        type: "semantic_text",
+        inference_id: "jinaai-embeddings",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/45954b8aaedfed57012be8b6538b0a24.asciidoc

@@ -0,0 +1,47 @@
+// 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: "POST",
+  path: "/_inference/chat_completion/openai-completion/_stream",
+  body: {
+    messages: [
+      {
+        role: "user",
+        content: [
+          {
+            type: "text",
+            text: "What's the price of a scarf?",
+          },
+        ],
+      },
+    ],
+    tools: [
+      {
+        type: "function",
+        function: {
+          name: "get_current_price",
+          description: "Get the current price of a item",
+          parameters: {
+            type: "object",
+            properties: {
+              item: {
+                id: "123",
+              },
+            },
+          },
+        },
+      },
+    ],
+    tool_choice: {
+      type: "function",
+      function: {
+        name: "get_current_price",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/4de4bb55bbc0a76c75d256f245a3ee3f.asciidoc

@@ -0,0 +1,17 @@
+// 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: "sparse_embedding",
+  inference_id: "elser-model-eis",
+  inference_config: {
+    service: "elastic",
+    service_settings: {
+      model_name: "elser",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/519e46350316a33162740e5d7968aa2c.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({
+  index: "image-index",
+  knn: {
+    field: "image-vector",
+    query_vector: [-5, 9, -12],
+    k: 10,
+    num_candidates: 100,
+    rescore_vector: {
+      oversample: 2,
+    },
+  },
+  fields: ["title", "file-type"],
+});
+console.log(response);
+----

docs/doc_examples/537bce129338d9227bccb6a0283dab45.asciidoc

@@ -5,7 +5,7 @@
 ----
 const response = await client.cluster.putSettings({
   persistent: {
-    "cluster.routing.allocation.disk.watermark.low": "30gb",
+    "migrate.data_stream_reindex_max_request_per_second": 10000,
   },
 });
 console.log(response);

docs/doc_examples/5836b09198feb1269ed12839b416123d.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: "jinaai-index",
+  query: {
+    semantic: {
+      field: "content",
+      query: "who inspired taking care of the sea?",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/59aa5216630f80c5dc298fc5bba4a819.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.getSettings({
+  index: ".reindexed-v9-ml-anomalies-custom-example",
+});
+console.log(response);
+----

docs/doc_examples/6b67c6121efb86ee100d40c2646f77b5.asciidoc

@@ -4,9 +4,11 @@
 [source, js]
 ----
 const response = await client.indices.putSettings({
-  index: "my-index-000001",
+  index: "*",
   settings: {
     "index.search.slowlog.include.user": true,
+    "index.search.slowlog.threshold.fetch.warn": "30s",
+    "index.search.slowlog.threshold.query.warn": "30s",
   },
 });
 console.log(response);

docs/doc_examples/6baf72c04d48cb04c2f8be609ff3b3b5.asciidoc

@@ -6,14 +6,15 @@
 const response = await client.search({
   index: "test-index",
   query: {
-    nested: {
-      path: "inference_field.inference.chunks",
-      query: {
-        sparse_vector: {
-          field: "inference_field.inference.chunks.embeddings",
-          inference_id: "my-inference-id",
-          query: "mountain lake",
-        },
+    match: {
+      my_semantic_field: "Which country is Paris in?",
+    },
+  },
+  highlight: {
+    fields: {
+      my_semantic_field: {
+        number_of_fragments: 2,
+        order: "score",
       },
     },
   },

docs/doc_examples/6e498b9dc753b94abf2618c407fa5cd8.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.reindex({
+  wait_for_completion: "false",
+  source: {
+    index: ".ml-anomalies-custom-example",
+  },
+  dest: {
+    index: ".reindexed-v9-ml-anomalies-custom-example",
+  },
+});
+console.log(response);
+----

docs/doc_examples/6fa02c2ad485bbe91f44b321158250f3.asciidoc

@@ -12,6 +12,13 @@ const response = await client.search({
       fields: ["my_field", "my_field._2gram", "my_field._3gram"],
     },
   },
+  highlight: {
+    fields: {
+      my_field: {
+        matched_fields: ["my_field._index_prefix"],
+      },
+    },
+  },
 });
 console.log(response);
 ----

docs/doc_examples/730045fae3743c39b612813a42c330c3.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: "my-index-000001",
+  query: {
+    prefix: {
+      full_name: {
+        value: "ki",
+      },
+    },
+  },
+  highlight: {
+    fields: {
+      full_name: {
+        matched_fields: ["full_name._index_prefix"],
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/7478ff69113fb53f41ea07cdf911fa67.asciidoc

@@ -0,0 +1,33 @@
+// 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: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    daily_sales: {
+      date_histogram: {
+        field: "order_date",
+        calendar_interval: "day",
+      },
+      aggs: {
+        daily_revenue: {
+          sum: {
+            field: "taxful_total_price",
+          },
+        },
+        smoothed_revenue: {
+          moving_fn: {
+            buckets_path: "daily_revenue",
+            window: 3,
+            script: "MovingFunctions.unweightedAvg(values)",
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/74b229a6e020113e5749099451979c89.asciidoc

@@ -1,26 +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({
-  index: "test-index",
-  query: {
-    nested: {
-      path: "inference_field.inference.chunks",
-      query: {
-        knn: {
-          field: "inference_field.inference.chunks.embeddings",
-          query_vector_builder: {
-            text_embedding: {
-              model_id: "my_inference_id",
-              model_text: "mountain lake",
-            },
-          },
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/77cebba946fe648873a1e7375c13df41.asciidoc

@@ -5,10 +5,8 @@
 ----
 const response = await client.cluster.putSettings({
   persistent: {
-    "cluster.routing.allocation.disk.watermark.low": "100gb",
-    "cluster.routing.allocation.disk.watermark.high": "50gb",
-    "cluster.routing.allocation.disk.watermark.flood_stage": "10gb",
-    "cluster.info.update.interval": "1m",
+    "cluster.routing.allocation.disk.watermark.low": "90%",
+    "cluster.routing.allocation.disk.watermark.high": "95%",
   },
 });
 console.log(response);

docs/doc_examples/790684b45bef2bb848ea932f0fd0cfbd.asciidoc

@@ -0,0 +1,35 @@
+// 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: {
+    intervals: {
+      my_text: {
+        all_of: {
+          ordered: false,
+          max_gaps: 1,
+          intervals: [
+            {
+              match: {
+                query: "my favorite food",
+                max_gaps: 0,
+                ordered: true,
+              },
+            },
+            {
+              match: {
+                query: "cold porridge",
+                max_gaps: 4,
+                ordered: true,
+              },
+            },
+          ],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/7bdc283b96c7a965fae23013647b8578.asciidoc

@@ -7,14 +7,14 @@ const response = await client.indices.create({
   index: "test-index",
   mappings: {
     properties: {
-      infer_field: {
-        type: "semantic_text",
-        inference_id: ".elser-2-elasticsearch",
-      },
       source_field: {
         type: "text",
         copy_to: "infer_field",
       },
+      infer_field: {
+        type: "semantic_text",
+        inference_id: ".elser-2-elasticsearch",
+      },
     },
   },
 });

docs/doc_examples/7dd0d9cc6c5982a2c003d301e90feeba.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.search({
+  index: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    daily_sales: {
+      date_histogram: {
+        field: "order_date",
+        calendar_interval: "day",
+        format: "yyyy-MM-dd",
+      },
+      aggs: {
+        revenue: {
+          sum: {
+            field: "taxful_total_price",
+          },
+        },
+        unique_customers: {
+          cardinality: {
+            field: "customer_id",
+          },
+        },
+        avg_basket_size: {
+          avg: {
+            field: "total_quantity",
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/82bb6c61dab959f4446dc5ecab7ecbdf.asciidoc

@@ -0,0 +1,34 @@
+// 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: "POST",
+  path: "/_inference/chat_completion/openai-completion/_stream",
+  body: {
+    messages: [
+      {
+        role: "assistant",
+        content: "Let's find out what the weather is",
+        tool_calls: [
+          {
+            id: "call_KcAjWtAww20AihPHphUh46Gd",
+            type: "function",
+            function: {
+              name: "get_current_weather",
+              arguments: '{"location":"Boston, MA"}',
+            },
+          },
+        ],
+      },
+      {
+        role: "tool",
+        content: "The weather is cold",
+        tool_call_id: "call_KcAjWtAww20AihPHphUh46Gd",
+      },
+    ],
+  },
+});
+console.log(response);
+----

docs/doc_examples/8621c05cc7cf3880bde751f6670a0c3a.asciidoc

@@ -4,9 +4,11 @@
 [source, js]
 ----
 const response = await client.indices.putSettings({
-  index: "my-index-000001",
+  index: ".reindexed-v9-ml-anomalies-custom-example",
   settings: {
-    "index.blocks.read_only_allow_delete": null,
+    index: {
+      number_of_replicas: 0,
+    },
   },
 });
 console.log(response);

docs/doc_examples/89f547649895176c246bb8c41313ff21.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.esql.query({
+  query:
+    '\nFROM library\n| EVAL year = DATE_EXTRACT("year", release_date)\n| WHERE page_count > ? AND match(author, ?, {"minimum_should_match": ?})\n| LIMIT 5\n',
+  params: [300, "Frank Herbert", 2],
+});
+console.log(response);
+----

docs/doc_examples/8c47c80139f40f25db44f5781ca2dfbe.asciidoc

@@ -3,8 +3,8 @@
 
 [source, js]
 ----
-const response = await client.security.queryRole({
-  sort: ["name"],
+const response = await client.indices.getAlias({
+  index: ".ml-anomalies-custom-example",
 });
 console.log(response);
 ----

docs/doc_examples/8c639d3eef5c2de29e12bd9c6a42d3d4.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.search({
+  index: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    categories: {
+      terms: {
+        field: "category.keyword",
+        size: 5,
+        order: {
+          total_revenue: "desc",
+        },
+      },
+      aggs: {
+        total_revenue: {
+          sum: {
+            field: "taxful_total_price",
+          },
+        },
+        avg_order_value: {
+          avg: {
+            field: "taxful_total_price",
+          },
+        },
+        total_items: {
+          sum: {
+            field: "total_quantity",
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/9250ac57ec81d5192e8ad4c462438489.asciidoc

@@ -0,0 +1,42 @@
+// 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.bulk({
+  index: "jinaai-index",
+  operations: [
+    {
+      index: {
+        _index: "jinaai-index",
+        _id: "1",
+      },
+    },
+    {
+      content:
+        "Sarah Johnson is a talented marine biologist working at the Oceanographic Institute. Her groundbreaking research on coral reef ecosystems has garnered international attention and numerous accolades.",
+    },
+    {
+      index: {
+        _index: "jinaai-index",
+        _id: "2",
+      },
+    },
+    {
+      content:
+        "She spends months at a time diving in remote locations, meticulously documenting the intricate relationships between various marine species. ",
+    },
+    {
+      index: {
+        _index: "jinaai-index",
+        _id: "3",
+      },
+    },
+    {
+      content:
+        "Her dedication to preserving these delicate underwater environments has inspired a new generation of conservationists.",
+    },
+  ],
+});
+console.log(response);
+----

docs/doc_examples/948418e0ef1b7e7cfee2f11be715d7d2.asciidoc

@@ -5,6 +5,9 @@
 ----
 const response = await client.indices.create({
   index: "retrievers_example_nested",
+  settings: {
+    number_of_shards: 1,
+  },
   mappings: {
     properties: {
       nested_field: {
@@ -18,6 +21,9 @@ const response = await client.indices.create({
             dims: 3,
             similarity: "l2_norm",
             index: true,
+            index_options: {
+              type: "flat",
+            },
           },
         },
       },

docs/doc_examples/9cc952d4a03264b700136cbc45abc8c6.asciidoc

@@ -0,0 +1,30 @@
+// 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-rank-vectors-byte",
+  mappings: {
+    properties: {
+      my_vector: {
+        type: "rank_vectors",
+        element_type: "byte",
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.index({
+  index: "my-rank-vectors-byte",
+  id: 1,
+  document: {
+    my_vector: [
+      [1, 2, 3],
+      [4, 5, 6],
+    ],
+  },
+});
+console.log(response1);
+----

docs/doc_examples/a46f566ca031375658c22f89b87dc6d2.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.cat.indices({
+  index: ".ml-anomalies-custom-example",
+  v: "true",
+  h: "index,store.size",
+});
+console.log(response);
+----

docs/doc_examples/a675fafa7c688cb3ea1be09bf887ebf0.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.get({
+  index: ".migrated-ds-my-data-stream-2025.01.23-000001",
+  human: "true",
+  filter_path: "*.settings.index.version.created_string",
+});
+console.log(response);
+----

docs/doc_examples/b590241c4296299b836fbb5a95bdd2dc.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.search({
+  index: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    avg_order_value: {
+      avg: {
+        field: "taxful_total_price",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/b6d278737d27973e498ac61cda9e5126.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.search({
+  index: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    daily_orders: {
+      date_histogram: {
+        field: "order_date",
+        calendar_interval: "day",
+        format: "yyyy-MM-dd",
+        min_doc_count: 0,
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/ba0e7e0b18fc9ec6c623d40186d1f61b.asciidoc

@@ -6,6 +6,7 @@
 const response = await client.indices.resolveCluster({
   name: "not-present,clust*:my-index*,oldcluster:*",
   ignore_unavailable: "false",
+  timeout: "5s",
 });
 console.log(response);
 ----

docs/doc_examples/bccd4eb26b1a325d103b12e198a13c08.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.getSettings({
+  index: "_all",
+  expand_wildcards: "all",
+  filter_path: "*.settings.index.*.slowlog",
+});
+console.log(response);
+----

docs/doc_examples/bcd1afb793240b1dddd9fa5d3f21192b.asciidoc

@@ -6,15 +6,11 @@
 const response = await client.update({
   index: "test",
   id: 1,
-  script: {
-    source: "ctx._source.counter += params.count",
-    lang: "painless",
-    params: {
-      count: 4,
-    },
+  doc: {
+    product_price: 100,
   },
   upsert: {
-    counter: 1,
+    product_price: 50,
   },
 });
 console.log(response);

docs/doc_examples/bdc55256fa5f701680631a149dbb75a9.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.search({
+  index: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    sales_by_category: {
+      terms: {
+        field: "category.keyword",
+        size: 5,
+        order: {
+          _count: "desc",
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/bdd28276618235487ac96bd6679bc206.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.search({
+  index: "kibana_sample_data_ecommerce",
+  size: 0,
+  aggs: {
+    daily_sales: {
+      date_histogram: {
+        field: "order_date",
+        calendar_interval: "day",
+      },
+      aggs: {
+        revenue: {
+          sum: {
+            field: "taxful_total_price",
+          },
+        },
+        cumulative_revenue: {
+          cumulative_sum: {
+            buckets_path: "revenue",
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/bf3c3bc41c593a80faebef1df353e483.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.inference.put({
+  task_type: "rerank",
+  inference_id: "jinaai-rerank",
+  inference_config: {
+    service: "jinaai",
+    service_settings: {
+      api_key: "<api_key>",
+      model_id: "jina-reranker-v2-base-multilingual",
+    },
+    task_settings: {
+      top_n: 10,
+      return_documents: true,
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/c3b77e11b16e37e9e37e28dec922432e.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.esql.query({
+  query:
+    '\nFROM library\n| WHERE match(author, "Frank Herbert", {"minimum_should_match": 2, "operator": "AND"})\n| LIMIT 5\n',
+});
+console.log(response);
+----

docs/doc_examples/cdb7613b445e6ed6e8b473f9cae1af90.asciidoc

@@ -0,0 +1,35 @@
+// 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: {
+    intervals: {
+      my_text: {
+        all_of: {
+          ordered: true,
+          max_gaps: 1,
+          intervals: [
+            {
+              match: {
+                query: "my favorite food",
+                max_gaps: 0,
+                ordered: true,
+              },
+            },
+            {
+              match: {
+                query: "cold porridge",
+                max_gaps: 4,
+                ordered: true,
+              },
+            },
+          ],
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/d2e7dead222cfbebbd2c21a7cc1893b4.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.cluster.state({
+  metric: "metadata",
+  filter_path: "metadata.indices.*.system",
+});
+console.log(response);
+----

docs/doc_examples/d3672a87a857ddb87519788236e57497.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.search({
+  index: "jinaai-index",
+  retriever: {
+    text_similarity_reranker: {
+      retriever: {
+        standard: {
+          query: {
+            semantic: {
+              field: "content",
+              query: "who inspired taking care of the sea?",
+            },
+          },
+        },
+      },
+      field: "content",
+      rank_window_size: 100,
+      inference_id: "jinaai-rerank",
+      inference_text: "who inspired taking care of the sea?",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/d3a0f648d0fd50b54a4e9ebe363c5047.asciidoc

@@ -0,0 +1,44 @@
+// 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: {
+    linear: {
+      retrievers: [
+        {
+          retriever: {
+            standard: {
+              query: {
+                query_string: {
+                  query: "(information retrieval) OR (artificial intelligence)",
+                  default_field: "text",
+                },
+              },
+            },
+          },
+          weight: 2,
+          normalizer: "minmax",
+        },
+        {
+          retriever: {
+            knn: {
+              field: "vector",
+              query_vector: [0.23, 0.67, 0.89],
+              k: 3,
+              num_candidates: 5,
+            },
+          },
+          weight: 1.5,
+          normalizer: "minmax",
+        },
+      ],
+      rank_window_size: 10,
+    },
+  },
+  _source: false,
+});
+console.log(response);
+----

docs/doc_examples/d6a4548b29e939fb197189c20c7c016f.asciidoc

@@ -0,0 +1,17 @@
+// 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: "chat_completion",
+  inference_id: "chat-completion-endpoint",
+  inference_config: {
+    service: "elastic",
+    service_settings: {
+      model_id: "model-1",
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/dd16c9c981551c9da47ebb5ef5105fa0.asciidoc

@@ -0,0 +1,57 @@
+// 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.updateAliases({
+  actions: [
+    {
+      add: {
+        index: ".reindexed-v9-ml-anomalies-custom-example",
+        alias: ".ml-anomalies-example1",
+        filter: {
+          term: {
+            job_id: {
+              value: "example1",
+            },
+          },
+        },
+        is_hidden: true,
+      },
+    },
+    {
+      add: {
+        index: ".reindexed-v9-ml-anomalies-custom-example",
+        alias: ".ml-anomalies-example2",
+        filter: {
+          term: {
+            job_id: {
+              value: "example2",
+            },
+          },
+        },
+        is_hidden: true,
+      },
+    },
+    {
+      remove: {
+        index: ".ml-anomalies-custom-example",
+        aliases: ".ml-anomalies-*",
+      },
+    },
+    {
+      remove_index: {
+        index: ".ml-anomalies-custom-example",
+      },
+    },
+    {
+      add: {
+        index: ".reindexed-v9-ml-anomalies-custom-example",
+        alias: ".ml-anomalies-custom-example",
+        is_hidden: true,
+      },
+    },
+  ],
+});
+console.log(response);
+----

docs/doc_examples/df81b88a2192dd6f9912e0c948a44487.asciidoc

@@ -7,7 +7,7 @@ const response = await client.inference.put({
   task_type: "sparse_embedding",
   inference_id: "elser_embeddings",
   inference_config: {
-    service: "elser",
+    service: "elasticsearch",
     service_settings: {
       num_allocations: 1,
       num_threads: 1,

docs/doc_examples/e375c7da666276c4df6664c6821cd5f4.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-rank-vectors-float",
+  mappings: {
+    properties: {
+      my_vector: {
+        type: "rank_vectors",
+      },
+    },
+  },
+});
+console.log(response);
+
+const response1 = await client.index({
+  index: "my-rank-vectors-float",
+  id: 1,
+  document: {
+    my_vector: [
+      [0.5, 10, 6],
+      [-0.5, 10, 10],
+    ],
+  },
+});
+console.log(response1);
+----

docs/doc_examples/e715fb8c792bf09ac98f0ceca99beb84.asciidoc

@@ -3,8 +3,8 @@
 
 [source, js]
 ----
-const response = await client.indices.unfreeze({
-  index: "my-index-000001",
+const response = await client.migration.deprecations({
+  index: ".ml-anomalies-*",
 });
 console.log(response);
 ----

docs/doc_examples/ec4b43c3ebd8816799fa004596b2f0cb.asciidoc

@@ -4,9 +4,10 @@
 [source, js]
 ----
 const response = await client.indices.putSettings({
-  index: "my-index-000001",
+  index: "*",
   settings: {
     "index.indexing.slowlog.include.user": true,
+    "index.indexing.slowlog.threshold.index.warn": "30s",
   },
 });
 console.log(response);

docs/doc_examples/f994498dd6576be657dedce2822d2b9e.asciidoc

@@ -30,6 +30,13 @@ const response = await client.search({
       ],
     },
   },
+  highlight: {
+    fields: {
+      semantic_text: {
+        number_of_fragments: 2,
+      },
+    },
+  },
 });
 console.log(response);
 ----

docs/doc_examples/ffda10edaa7ce087703193c3cb95a426.asciidoc

@@ -5,6 +5,9 @@
 ----
 const response = await client.indices.create({
   index: "retrievers_example",
+  settings: {
+    number_of_shards: 1,
+  },
   mappings: {
     properties: {
       vector: {
@@ -12,6 +15,9 @@ const response = await client.indices.create({
         dims: 3,
         similarity: "l2_norm",
         index: true,
+        index_options: {
+          type: "flat",
+        },
       },
       text: {
         type: "text",
@@ -22,6 +28,9 @@ const response = await client.indices.create({
       topic: {
         type: "keyword",
       },
+      timestamp: {
+        type: "date",
+      },
     },
   },
 });
@@ -35,6 +44,7 @@ const response1 = await client.index({
     text: "Large language models are revolutionizing information retrieval by boosting search precision, deepening contextual understanding, and reshaping user experiences in data-rich environments.",
     year: 2024,
     topic: ["llm", "ai", "information_retrieval"],
+    timestamp: "2021-01-01T12:10:30",
   },
 });
 console.log(response1);
@@ -47,6 +57,7 @@ const response2 = await client.index({
     text: "Artificial intelligence is transforming medicine, from advancing diagnostics and tailoring treatment plans to empowering predictive patient care for improved health outcomes.",
     year: 2023,
     topic: ["ai", "medicine"],
+    timestamp: "2022-01-01T12:10:30",
   },
 });
 console.log(response2);
@@ -59,6 +70,7 @@ const response3 = await client.index({
     text: "AI is redefining security by enabling advanced threat detection, proactive risk analysis, and dynamic defenses against increasingly sophisticated cyber threats.",
     year: 2024,
     topic: ["ai", "security"],
+    timestamp: "2023-01-01T12:10:30",
   },
 });
 console.log(response3);
@@ -71,6 +83,7 @@ const response4 = await client.index({
     text: "Elastic introduces Elastic AI Assistant, the open, generative AI sidekick powered by ESRE to democratize cybersecurity and enable users of every skill level.",
     year: 2023,
     topic: ["ai", "elastic", "assistant"],
+    timestamp: "2024-01-01T12:10:30",
   },
 });
 console.log(response4);
@@ -83,6 +96,7 @@ const response5 = await client.index({
     text: "Learn how to spin up a deployment of our hosted Elasticsearch Service and use Elastic Observability to gain deeper insight into the behavior of your applications and systems.",
     year: 2024,
     topic: ["documentation", "observability", "elastic"],
+    timestamp: "2025-01-01T12:10:30",
   },
 });
 console.log(response5);

docs/doc_examples/fff86117c47f974074284644e8a97a99.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: "text_embedding",
+  inference_id: "jinaai-embeddings",
+  inference_config: {
+    service: "jinaai",
+    service_settings: {
+      model_id: "jina-embeddings-v3",
+      api_key: "<api_key>",
+    },
+  },
+});
+console.log(response);
+----

docs/helpers.asciidoc

@@ -715,7 +715,7 @@ const result = await client.helpers
 
 ES|QL can return results in multiple binary formats, including https://arrow.apache.org/[Apache Arrow]'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 https://arrow.apache.org/docs/js/classes/Arrow_dom.RecordBatchReader.html[`RecordBatchStreamReader`].
+`toArrowReader` returns a https://github.com/apache/arrow/blob/520ae44272d491bbb52eb3c9b84864ed7088f11a/js/src/ipc/reader.ts#L216[`AsyncRecordBatchStreamReader`].
 
 [source,ts]
 ----
@@ -724,7 +724,7 @@ 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())
   }

docs/observability.asciidoc

@@ -97,7 +97,7 @@ client.diagnostic.on('request', (err, result) => {
 ----
 
 |`deserialization`
-a|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)_.
+a|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, like: when `asStream` is set to true; a response is terminated early due to content length being too large; or a response is terminated early by an `AbortController`.
 [source,js]
 ----
 client.diagnostic.on('deserialization', (err, result) => {

index.d.ts

@@ -25,3 +25,4 @@ 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'

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/elasticsearch",
-  "version": "8.16.3",
-  "versionCanary": "8.16.3-canary.0",
+  "version": "8.18.2",
+  "versionCanary": "8.18.2-canary.0",
   "description": "The official Elasticsearch client for Node.js",
   "main": "./index.js",
   "types": "index.d.ts",
@@ -18,7 +18,8 @@
     "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'",
@@ -56,42 +57,41 @@
     "node": ">=18"
   },
   "devDependencies": {
-    "@elastic/request-converter": "^8.16.1",
-    "@sinonjs/fake-timers": "github:sinonjs/fake-timers#0bfffc1",
-    "@types/debug": "^4.1.7",
-    "@types/ms": "^0.7.31",
-    "@types/node": "^18.19.55",
-    "@types/sinonjs__fake-timers": "^8.1.2",
-    "@types/split2": "^3.2.1",
-    "@types/stoppable": "^1.1.1",
-    "@types/tap": "^15.0.7",
-    "chai": "^4.3.7",
-    "cross-zip": "^4.0.0",
-    "desm": "^1.2.0",
-    "into-stream": "^7.0.0",
-    "js-yaml": "^4.1.0",
-    "license-checker": "^25.0.1",
-    "minimist": "^1.2.6",
-    "ms": "^2.1.3",
-    "node-abort-controller": "^3.0.1",
-    "node-fetch": "^2.6.7",
-    "ora": "^5.4.1",
-    "proxy": "^1.0.2",
-    "rimraf": "^3.0.2",
-    "semver": "^7.3.7",
-    "split2": "^4.1.0",
-    "stoppable": "^1.1.0",
-    "tap": "^21.0.1",
-    "ts-node": "^10.7.0",
-    "ts-standard": "^12.0.2",
-    "typescript": "^4.6.4",
-    "workq": "^3.0.0",
-    "xmlbuilder2": "^3.0.2",
-    "zx": "^7.2.2"
+    "@elastic/request-converter": "8.17.0",
+    "@sinonjs/fake-timers": "github:sinonjs/fake-timers#48f089f",
+    "@types/debug": "4.1.12",
+    "@types/ms": "0.7.34",
+    "@types/node": "22.10.7",
+    "@types/sinonjs__fake-timers": "8.1.5",
+    "@types/split2": "4.2.3",
+    "@types/stoppable": "1.1.3",
+    "chai": "5.1.2",
+    "cross-zip": "4.0.1",
+    "desm": "1.3.1",
+    "into-stream": "8.0.1",
+    "js-yaml": "4.1.0",
+    "license-checker": "25.0.1",
+    "minimist": "1.2.8",
+    "ms": "2.1.3",
+    "node-abort-controller": "3.1.1",
+    "node-fetch": "2.7.0",
+    "ora": "5.4.1",
+    "proxy": "1.0.2",
+    "rimraf": "5.0.10",
+    "semver": "7.7.1",
+    "split2": "4.2.0",
+    "stoppable": "1.1.0",
+    "tap": "21.0.1",
+    "ts-node": "10.9.2",
+    "ts-standard": "12.0.2",
+    "typescript": "5.7.3",
+    "workq": "3.0.0",
+    "xmlbuilder2": "3.1.1",
+    "zx": "7.2.3"
   },
   "dependencies": {
-    "@elastic/transport": "^8.9.1",
-    "apache-arrow": "^18.0.0",
+    "@elastic/transport": "^8.9.6",
+    "apache-arrow": "18.x - 19.x",
     "tslib": "^2.4.0"
   },
   "tap": {

scripts/download-artifacts.js

@@ -17,162 +17,102 @@
  * under the License.
  */
 
-'use strict'
-
 const { join } = require('path')
-const minimist = require('minimist')
 const stream = require('stream')
 const { promisify } = require('util')
 const { createWriteStream, promises } = require('fs')
-const rimraf = require('rimraf')
+const { rimraf } = require('rimraf')
 const fetch = require('node-fetch')
 const crossZip = require('cross-zip')
 const ora = require('ora')
 
-const { mkdir, writeFile } = promises
+const { mkdir, cp } = promises
 const pipeline = promisify(stream.pipeline)
 const unzip = promisify(crossZip.unzip)
-const rm = promisify(rimraf)
 
-const esFolder = join(__dirname, '..', 'elasticsearch')
-const zipFolder = join(esFolder, 'artifacts.zip')
-const specFolder = join(esFolder, 'rest-api-spec', 'api')
-const freeTestFolder = join(esFolder, 'rest-api-spec', 'test', 'free')
-const xPackTestFolder = join(esFolder, 'rest-api-spec', 'test', 'platinum')
-const artifactInfo = join(esFolder, 'info.json')
+const testYamlFolder = join(__dirname, '..', 'yaml-rest-tests')
+const zipFile = join(__dirname, '..', 'elasticsearch-clients-tests.zip')
 
-async function downloadArtifacts (opts) {
-  if (typeof opts.version !== 'string') {
-    throw new Error('Missing version')
-  }
+const schemaFolder = join(__dirname, '..', 'schema')
+const schemaJson = join(schemaFolder, 'schema.json')
 
+async function downloadArtifacts (localTests, version = 'main') {
   const log = ora('Checking out spec and test').start()
 
-  log.text = 'Resolving versions'
-  let resolved
-  try {
-    resolved = await resolve(opts.version, opts.hash)
-  } catch (err) {
-    log.fail(err.message)
-    process.exit(1)
+  const { GITHUB_TOKEN } = process.env
+
+  if (version !== 'main') {
+    version = version.split('.').slice(0, 2).join('.')
   }
 
-  opts.id = opts.id || resolved.id
-  opts.hash = opts.hash || resolved.hash
-  opts.version = resolved.version
+  log.text = 'Clean tests folder'
+  await rimraf(testYamlFolder)
+  await mkdir(testYamlFolder, { recursive: true })
 
-  const info = loadInfo()
+  log.text = `Fetch test YAML files for version ${version}`
 
-  if (info && info.version === opts.version) {
-    if (info.hash === opts.hash && info.id === opts.id) {
-      log.succeed('The artifact copy present locally is already up to date')
-      return
+  if (localTests) {
+    log.text = `Copying local tests from ${localTests}`
+    await cp(localTests, testYamlFolder, { recursive: true })
+  } else {
+    if (!GITHUB_TOKEN) {
+      log.fail("Missing required environment variable 'GITHUB_TOKEN'")
+      process.exit(1)
     }
+
+    const response = await fetch(`https://api.github.com/repos/elastic/elasticsearch-clients-tests/zipball/${version}`, {
+      headers: {
+        Authorization: `Bearer ${GITHUB_TOKEN}`,
+        Accept: 'application/vnd.github+json'
+      }
+    })
+
+    if (!response.ok) {
+      log.fail(`unexpected response ${response.statusText}`)
+      process.exit(1)
+    }
+
+    log.text = 'Downloading tests zipball'
+    await pipeline(response.body, createWriteStream(zipFile))
+
+    log.text = 'Unzipping tests'
+    await unzip(zipFile, testYamlFolder)
+
+    log.text = 'Cleanup'
+    await rimraf(zipFile)
   }
 
-  log.text = 'Cleanup checkouts/elasticsearch'
-  await rm(esFolder)
-  await mkdir(esFolder, { recursive: true })
+  log.text = 'Fetching Elasticsearch specification'
+  await rimraf(schemaFolder)
+  await mkdir(schemaFolder, { recursive: true })
 
-  log.text = 'Downloading artifacts'
-  const response = await fetch(resolved.url)
+  const response = await fetch(`https://raw.githubusercontent.com/elastic/elasticsearch-specification/${version}/output/schema/schema.json`)
   if (!response.ok) {
     log.fail(`unexpected response ${response.statusText}`)
     process.exit(1)
   }
-  await pipeline(response.body, createWriteStream(zipFolder))
 
-  log.text = 'Unzipping'
-  await unzip(zipFolder, esFolder)
-
-  log.text = 'Cleanup'
-  await rm(zipFolder)
-
-  log.text = 'Update info'
-  await writeFile(artifactInfo, JSON.stringify(opts), 'utf8')
+  log.text = 'Downloading schema.json'
+  await pipeline(response.body, createWriteStream(schemaJson))
 
   log.succeed('Done')
 }
 
-function loadInfo () {
-  try {
-    return require(artifactInfo)
-  } catch (err) {
-    return null
-  }
+async function main () {
+  await downloadArtifacts()
 }
 
-async function resolve (version, hash) {
-  const response = await fetch(`https://artifacts-api.elastic.co/v1/versions/${version}`)
-  if (!response.ok) {
-    throw new Error(`unexpected response ${response.statusText}`)
-  }
-
-  const data = await response.json()
-  const esBuilds = data.version.builds
-    .filter(build => build.projects.elasticsearch != null)
-    .map(build => {
-      return {
-        projects: build.projects.elasticsearch,
-        buildId: build.build_id,
-        date: build.start_time,
-        version: build.version
-      }
-    })
-    .sort((a, b) => {
-      const dA = new Date(a.date)
-      const dB = new Date(b.date)
-      if (dA > dB) return -1
-      if (dA < dB) return 1
-      return 0
-    })
-
-  if (hash != null) {
-    const build = esBuilds.find(build => build.projects.commit_hash === hash)
-    if (!build) {
-      throw new Error(`Can't find any build with hash '${hash}'`)
-    }
-    const zipKey = Object.keys(build.projects.packages).find(key => key.startsWith('rest-resources-zip-') && key.endsWith('.zip'))
-    return {
-      url: build.projects.packages[zipKey].url,
-      id: build.buildId,
-      hash: build.projects.commit_hash,
-      version: build.version
-    }
-  }
-
-  const lastBuild = esBuilds[0]
-  const zipKey = Object.keys(lastBuild.projects.packages).find(key => key.startsWith('rest-resources-zip-') && key.endsWith('.zip'))
-  return {
-    url: lastBuild.projects.packages[zipKey].url,
-    id: lastBuild.buildId,
-    hash: lastBuild.projects.commit_hash,
-    version: lastBuild.version
-  }
-}
-
-async function main (options) {
-  delete options._
-  await downloadArtifacts(options)
-}
 if (require.main === module) {
   process.on('unhandledRejection', function (err) {
     console.error(err)
     process.exit(1)
   })
 
-  const options = minimist(process.argv.slice(2), {
-    string: ['id', 'version', 'hash']
-  })
-  main(options).catch(t => {
+  main().catch(t => {
     console.log(t)
     process.exit(2)
   })
 }
 
 module.exports = downloadArtifacts
-module.exports.locations = {
-  specFolder,
-  freeTestFolder,
-  xPackTestFolder
-}
+module.exports.locations = { testYamlFolder, zipFile, schemaJson }

scripts/generate-docs-examples.js

@@ -20,7 +20,7 @@
 const { join } = require('path')
 const { writeFile } = require('fs/promises')
 const fetch = require('node-fetch')
-const rimraf = require('rimraf')
+const { rimraf } = require('rimraf')
 const ora = require('ora')
 const { convertRequests } = require('@elastic/request-converter')
 const minimist = require('minimist')
@@ -91,6 +91,7 @@ ${source.trim()}
 }
 
 const options = minimist(process.argv.slice(2), {
+  boolean: ['debug'],
   string: ['version'],
   default: {
     version: 'master'
@@ -102,7 +103,7 @@ generate(options.version)
   .catch(err => log.fail(err.message))
   .finally(() => {
     const keys = Object.keys(failures)
-    if (keys.length > 0) {
+    if (keys.length > 0 && options.debug) {
       let message = 'Some examples failed to generate:\n\n'
       for (const key of keys) {
         message += `${key}: ${failures[key]}\n`

src/api/api/async_search.ts

@@ -46,7 +46,7 @@ export default class AsyncSearch {
 
   /**
     * Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html | Elasticsearch API documentation}
     */
   async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchDeleteResponse>
   async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchDeleteResponse, unknown>>
@@ -78,7 +78,7 @@ export default class AsyncSearch {
 
   /**
     * Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html | Elasticsearch API documentation}
     */
   async get<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchGetResponse<TDocument, TAggregations>>
   async get<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchGetResponse<TDocument, TAggregations>, unknown>>
@@ -109,8 +109,8 @@ export default class AsyncSearch {
   }
 
   /**
-    * Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html | Elasticsearch API documentation}
+    * Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to: * The user or API key that submitted the original async search request. * Users that have the `monitor` cluster privilege or greater privileges.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html | Elasticsearch API documentation}
     */
   async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchStatusResponse>
   async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchStatusResponse, unknown>>
@@ -142,7 +142,7 @@ export default class AsyncSearch {
 
   /**
     * Run an async search. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html | Elasticsearch API documentation}
     */
   async submit<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchSubmitResponse<TDocument, TAggregations>>
   async submit<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchSubmitResponse<TDocument, TAggregations>, unknown>>

src/api/api/autoscaling.ts

@@ -46,7 +46,7 @@ export default class Autoscaling {
 
   /**
     * Delete an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-delete-autoscaling-policy.html | Elasticsearch API documentation}
     */
   async deleteAutoscalingPolicy (this: That, params: T.AutoscalingDeleteAutoscalingPolicyRequest | TB.AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AutoscalingDeleteAutoscalingPolicyResponse>
   async deleteAutoscalingPolicy (this: That, params: T.AutoscalingDeleteAutoscalingPolicyRequest | TB.AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AutoscalingDeleteAutoscalingPolicyResponse, unknown>>
@@ -78,7 +78,7 @@ export default class Autoscaling {
 
   /**
     * Get the autoscaling capacity. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload. The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html | Elasticsearch API documentation}
     */
   async getAutoscalingCapacity (this: That, params?: T.AutoscalingGetAutoscalingCapacityRequest | TB.AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AutoscalingGetAutoscalingCapacityResponse>
   async getAutoscalingCapacity (this: That, params?: T.AutoscalingGetAutoscalingCapacityRequest | TB.AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AutoscalingGetAutoscalingCapacityResponse, unknown>>
@@ -108,7 +108,7 @@ export default class Autoscaling {
 
   /**
     * Get an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html | Elasticsearch API documentation}
     */
   async getAutoscalingPolicy (this: That, params: T.AutoscalingGetAutoscalingPolicyRequest | TB.AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AutoscalingGetAutoscalingPolicyResponse>
   async getAutoscalingPolicy (this: That, params: T.AutoscalingGetAutoscalingPolicyRequest | TB.AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AutoscalingGetAutoscalingPolicyResponse, unknown>>
@@ -140,7 +140,7 @@ export default class Autoscaling {
 
   /**
     * Create or update an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-put-autoscaling-policy.html | Elasticsearch API documentation}
     */
   async putAutoscalingPolicy (this: That, params: T.AutoscalingPutAutoscalingPolicyRequest | TB.AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AutoscalingPutAutoscalingPolicyResponse>
   async putAutoscalingPolicy (this: That, params: T.AutoscalingPutAutoscalingPolicyRequest | TB.AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AutoscalingPutAutoscalingPolicyResponse, unknown>>

src/api/api/cat.ts

@@ -45,8 +45,8 @@ export default class Cat {
   }
 
   /**
-    * Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html | Elasticsearch API documentation}
+    * Get aliases. Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-alias.html | Elasticsearch API documentation}
     */
   async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAliasesResponse>
   async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAliasesResponse, unknown>>
@@ -85,8 +85,8 @@ export default class Cat {
   }
 
   /**
-    * Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html | Elasticsearch API documentation}
+    * Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-allocation.html | Elasticsearch API documentation}
     */
   async allocation (this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAllocationResponse>
   async allocation (this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAllocationResponse, unknown>>
@@ -125,8 +125,8 @@ export default class Cat {
   }
 
   /**
-    * Get component templates. Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-component-templates.html | Elasticsearch API documentation}
+    * Get component templates. Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-component-templates.html | Elasticsearch API documentation}
     */
   async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatComponentTemplatesResponse>
   async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatComponentTemplatesResponse, unknown>>
@@ -165,8 +165,8 @@ export default class Cat {
   }
 
   /**
-    * Get a document count. Provides quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html | Elasticsearch API documentation}
+    * Get a document count. Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-count.html | Elasticsearch API documentation}
     */
   async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatCountResponse>
   async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatCountResponse, unknown>>
@@ -205,8 +205,8 @@ export default class Cat {
   }
 
   /**
-    * Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html | Elasticsearch API documentation}
+    * Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-fielddata.html | Elasticsearch API documentation}
     */
   async fielddata (this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatFielddataResponse>
   async fielddata (this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatFielddataResponse, unknown>>
@@ -245,8 +245,8 @@ export default class Cat {
   }
 
   /**
-    * Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html | Elasticsearch API documentation}
+    * Get the cluster health status. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-health.html | Elasticsearch API documentation}
     */
   async health (this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHealthResponse>
   async health (this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHealthResponse, unknown>>
@@ -275,8 +275,8 @@ export default class Cat {
   }
 
   /**
-    * Get CAT help. Returns help for the CAT APIs.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat.html | Elasticsearch API documentation}
+    * Get CAT help. Get help for the CAT APIs.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat.html | Elasticsearch API documentation}
     */
   async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHelpResponse>
   async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHelpResponse, unknown>>
@@ -305,8 +305,8 @@ export default class Cat {
   }
 
   /**
-    * Get index information. Returns high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html | Elasticsearch API documentation}
+    * Get index information. Get high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-indices.html | Elasticsearch API documentation}
     */
   async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatIndicesResponse>
   async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatIndicesResponse, unknown>>
@@ -345,8 +345,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-master.html | Elasticsearch API documentation}
+    * Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-master.html | Elasticsearch API documentation}
     */
   async master (this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMasterResponse>
   async master (this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMasterResponse, unknown>>
@@ -375,8 +375,8 @@ export default class Cat {
   }
 
   /**
-    * Get data frame analytics jobs. Returns configuration and usage information about data frame analytics jobs. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html | Elasticsearch API documentation}
+    * Get data frame analytics jobs. Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-dfanalytics.html | Elasticsearch API documentation}
     */
   async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDataFrameAnalyticsResponse>
   async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDataFrameAnalyticsResponse, unknown>>
@@ -415,8 +415,8 @@ export default class Cat {
   }
 
   /**
-    * Get datafeeds. Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html | Elasticsearch API documentation}
+    * Get datafeeds. Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-datafeeds.html | Elasticsearch API documentation}
     */
   async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDatafeedsResponse>
   async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDatafeedsResponse, unknown>>
@@ -455,8 +455,8 @@ export default class Cat {
   }
 
   /**
-    * Get anomaly detection jobs. Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html | Elasticsearch API documentation}
+    * Get anomaly detection jobs. Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-anomaly-detectors.html | Elasticsearch API documentation}
     */
   async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlJobsResponse>
   async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlJobsResponse, unknown>>
@@ -495,8 +495,8 @@ export default class Cat {
   }
 
   /**
-    * Get trained models. Returns configuration and usage information about inference trained models. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html | Elasticsearch API documentation}
+    * Get trained models. Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-trained-model.html | Elasticsearch API documentation}
     */
   async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlTrainedModelsResponse>
   async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlTrainedModelsResponse, unknown>>
@@ -535,8 +535,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodeattrs.html | Elasticsearch API documentation}
+    * Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-nodeattrs.html | Elasticsearch API documentation}
     */
   async nodeattrs (this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodeattrsResponse>
   async nodeattrs (this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodeattrsResponse, unknown>>
@@ -565,8 +565,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html | Elasticsearch API documentation}
+    * Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-nodes.html | Elasticsearch API documentation}
     */
   async nodes (this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodesResponse>
   async nodes (this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodesResponse, unknown>>
@@ -595,8 +595,8 @@ export default class Cat {
   }
 
   /**
-    * Returns cluster-level changes that have not yet been executed. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-pending-tasks.html | Elasticsearch API documentation}
+    * Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-pending-tasks.html | Elasticsearch API documentation}
     */
   async pendingTasks (this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPendingTasksResponse>
   async pendingTasks (this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPendingTasksResponse, unknown>>
@@ -625,8 +625,8 @@ export default class Cat {
   }
 
   /**
-    * Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-plugins.html | Elasticsearch API documentation}
+    * Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-plugins.html | Elasticsearch API documentation}
     */
   async plugins (this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPluginsResponse>
   async plugins (this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPluginsResponse, unknown>>
@@ -655,8 +655,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html | Elasticsearch API documentation}
+    * Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-recovery.html | Elasticsearch API documentation}
     */
   async recovery (this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRecoveryResponse>
   async recovery (this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRecoveryResponse, unknown>>
@@ -695,8 +695,8 @@ export default class Cat {
   }
 
   /**
-    * Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-repositories.html | Elasticsearch API documentation}
+    * Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-repositories.html | Elasticsearch API documentation}
     */
   async repositories (this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRepositoriesResponse>
   async repositories (this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRepositoriesResponse, unknown>>
@@ -725,8 +725,8 @@ export default class Cat {
   }
 
   /**
-    * Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html | Elasticsearch API documentation}
+    * Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-segments.html | Elasticsearch API documentation}
     */
   async segments (this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSegmentsResponse>
   async segments (this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSegmentsResponse, unknown>>
@@ -765,8 +765,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html | Elasticsearch API documentation}
+    * Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-shards.html | Elasticsearch API documentation}
     */
   async shards (this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatShardsResponse>
   async shards (this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatShardsResponse, unknown>>
@@ -805,8 +805,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html | Elasticsearch API documentation}
+    * Get snapshot information. Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-snapshots.html | Elasticsearch API documentation}
     */
   async snapshots (this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSnapshotsResponse>
   async snapshots (this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSnapshotsResponse, unknown>>
@@ -845,8 +845,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html | Elasticsearch API documentation}
+    * Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-tasks.html | Elasticsearch API documentation}
     */
   async tasks (this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTasksResponse>
   async tasks (this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTasksResponse, unknown>>
@@ -875,8 +875,8 @@ export default class Cat {
   }
 
   /**
-    * Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html | Elasticsearch API documentation}
+    * Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-templates.html | Elasticsearch API documentation}
     */
   async templates (this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTemplatesResponse>
   async templates (this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTemplatesResponse, unknown>>
@@ -915,8 +915,8 @@ export default class Cat {
   }
 
   /**
-    * Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html | Elasticsearch API documentation}
+    * Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-thread-pool.html | Elasticsearch API documentation}
     */
   async threadPool (this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatThreadPoolResponse>
   async threadPool (this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatThreadPoolResponse, unknown>>
@@ -955,8 +955,8 @@ export default class Cat {
   }
 
   /**
-    * Get transforms. Returns configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html | Elasticsearch API documentation}
+    * Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-transforms.html | Elasticsearch API documentation}
     */
   async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTransformsResponse>
   async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTransformsResponse, unknown>>

src/api/api/ccr.ts

@@ -45,8 +45,8 @@ export default class Ccr {
   }
 
   /**
-    * Deletes auto-follow patterns.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-delete-auto-follow-pattern.html | Elasticsearch API documentation}
+    * Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-delete-auto-follow-pattern.html | Elasticsearch API documentation}
     */
   async deleteAutoFollowPattern (this: That, params: T.CcrDeleteAutoFollowPatternRequest | TB.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrDeleteAutoFollowPatternResponse>
   async deleteAutoFollowPattern (this: That, params: T.CcrDeleteAutoFollowPatternRequest | TB.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrDeleteAutoFollowPatternResponse, unknown>>
@@ -77,15 +77,15 @@ export default class Ccr {
   }
 
   /**
-    * Creates a new follower index configured to follow the referenced leader index.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-follow.html | Elasticsearch API documentation}
+    * Create a follower. Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-put-follow.html | Elasticsearch API documentation}
     */
   async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrFollowResponse>
   async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrFollowResponse, unknown>>
   async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptions): Promise<T.CcrFollowResponse>
   async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptions): Promise<any> {
     const acceptedPath: string[] = ['index']
-    const acceptedBody: string[] = ['leader_index', 'max_outstanding_read_requests', 'max_outstanding_write_requests', 'max_read_request_operation_count', 'max_read_request_size', 'max_retry_delay', 'max_write_buffer_count', 'max_write_buffer_size', 'max_write_request_operation_count', 'max_write_request_size', 'read_poll_timeout', 'remote_cluster']
+    const acceptedBody: string[] = ['data_stream_name', 'leader_index', 'max_outstanding_read_requests', 'max_outstanding_write_requests', 'max_read_request_operation_count', 'max_read_request_size', 'max_retry_delay', 'max_write_buffer_count', 'max_write_buffer_size', 'max_write_request_operation_count', 'max_write_request_size', 'read_poll_timeout', 'remote_cluster', 'settings']
     const querystring: Record<string, any> = {}
     // @ts-expect-error
     const userBody: any = params?.body
@@ -121,8 +121,8 @@ export default class Ccr {
   }
 
   /**
-    * Retrieves information about all follower indices, including parameters and status for each follower index
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-info.html | Elasticsearch API documentation}
+    * Get follower information. Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-follow-info.html | Elasticsearch API documentation}
     */
   async followInfo (this: That, params: T.CcrFollowInfoRequest | TB.CcrFollowInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrFollowInfoResponse>
   async followInfo (this: That, params: T.CcrFollowInfoRequest | TB.CcrFollowInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrFollowInfoResponse, unknown>>
@@ -153,8 +153,8 @@ export default class Ccr {
   }
 
   /**
-    * Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-stats.html | Elasticsearch API documentation}
+    * Get follower stats. Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-follow-stats.html | Elasticsearch API documentation}
     */
   async followStats (this: That, params: T.CcrFollowStatsRequest | TB.CcrFollowStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrFollowStatsResponse>
   async followStats (this: That, params: T.CcrFollowStatsRequest | TB.CcrFollowStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrFollowStatsResponse, unknown>>
@@ -185,8 +185,8 @@ export default class Ccr {
   }
 
   /**
-    * Removes the follower retention leases from the leader.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-forget-follower.html | Elasticsearch API documentation}
+    * Forget a follower. Remove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so. NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-forget-follower.html | Elasticsearch API documentation}
     */
   async forgetFollower (this: That, params: T.CcrForgetFollowerRequest | TB.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrForgetFollowerResponse>
   async forgetFollower (this: That, params: T.CcrForgetFollowerRequest | TB.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrForgetFollowerResponse, unknown>>
@@ -229,8 +229,8 @@ export default class Ccr {
   }
 
   /**
-    * Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html | Elasticsearch API documentation}
+    * Get auto-follow patterns. Get cross-cluster replication auto-follow patterns.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-auto-follow-pattern.html | Elasticsearch API documentation}
     */
   async getAutoFollowPattern (this: That, params?: T.CcrGetAutoFollowPatternRequest | TB.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrGetAutoFollowPatternResponse>
   async getAutoFollowPattern (this: That, params?: T.CcrGetAutoFollowPatternRequest | TB.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrGetAutoFollowPatternResponse, unknown>>
@@ -269,8 +269,8 @@ export default class Ccr {
   }
 
   /**
-    * Pauses an auto-follow pattern
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-pause-auto-follow-pattern.html | Elasticsearch API documentation}
+    * Pause an auto-follow pattern. Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored. You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-pause-auto-follow-pattern.html | Elasticsearch API documentation}
     */
   async pauseAutoFollowPattern (this: That, params: T.CcrPauseAutoFollowPatternRequest | TB.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrPauseAutoFollowPatternResponse>
   async pauseAutoFollowPattern (this: That, params: T.CcrPauseAutoFollowPatternRequest | TB.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrPauseAutoFollowPatternResponse, unknown>>
@@ -301,8 +301,8 @@ export default class Ccr {
   }
 
   /**
-    * Pauses a follower index. The follower index will not fetch any additional operations from the leader index.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-pause-follow.html | Elasticsearch API documentation}
+    * Pause a follower. Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-pause-follow.html | Elasticsearch API documentation}
     */
   async pauseFollow (this: That, params: T.CcrPauseFollowRequest | TB.CcrPauseFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrPauseFollowResponse>
   async pauseFollow (this: That, params: T.CcrPauseFollowRequest | TB.CcrPauseFollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrPauseFollowResponse, unknown>>
@@ -333,8 +333,8 @@ export default class Ccr {
   }
 
   /**
-    * Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-auto-follow-pattern.html | Elasticsearch API documentation}
+    * Create or update auto-follow patterns. Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. This API can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-put-auto-follow-pattern.html | Elasticsearch API documentation}
     */
   async putAutoFollowPattern (this: That, params: T.CcrPutAutoFollowPatternRequest | TB.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrPutAutoFollowPatternResponse>
   async putAutoFollowPattern (this: That, params: T.CcrPutAutoFollowPatternRequest | TB.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrPutAutoFollowPatternResponse, unknown>>
@@ -377,8 +377,8 @@ export default class Ccr {
   }
 
   /**
-    * Resumes an auto-follow pattern that has been paused
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-resume-auto-follow-pattern.html | Elasticsearch API documentation}
+    * Resume an auto-follow pattern. Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-resume-auto-follow-pattern.html | Elasticsearch API documentation}
     */
   async resumeAutoFollowPattern (this: That, params: T.CcrResumeAutoFollowPatternRequest | TB.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrResumeAutoFollowPatternResponse>
   async resumeAutoFollowPattern (this: That, params: T.CcrResumeAutoFollowPatternRequest | TB.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrResumeAutoFollowPatternResponse, unknown>>
@@ -409,8 +409,8 @@ export default class Ccr {
   }
 
   /**
-    * Resumes a follower index that has been paused
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-resume-follow.html | Elasticsearch API documentation}
+    * Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-resume-follow.html | Elasticsearch API documentation}
     */
   async resumeFollow (this: That, params: T.CcrResumeFollowRequest | TB.CcrResumeFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrResumeFollowResponse>
   async resumeFollow (this: That, params: T.CcrResumeFollowRequest | TB.CcrResumeFollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrResumeFollowResponse, unknown>>
@@ -453,8 +453,8 @@ export default class Ccr {
   }
 
   /**
-    * Gets all stats related to cross-cluster replication.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-stats.html | Elasticsearch API documentation}
+    * Get cross-cluster replication stats. This API returns stats about auto-following and the same shard-level stats as the get follower stats API.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-stats.html | Elasticsearch API documentation}
     */
   async stats (this: That, params?: T.CcrStatsRequest | TB.CcrStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrStatsResponse>
   async stats (this: That, params?: T.CcrStatsRequest | TB.CcrStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrStatsResponse, unknown>>
@@ -483,8 +483,8 @@ export default class Ccr {
   }
 
   /**
-    * Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
-    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-unfollow.html | Elasticsearch API documentation}
+    * Unfollow an index. Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API. > info > Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-unfollow.html | Elasticsearch API documentation}
     */
   async unfollow (this: That, params: T.CcrUnfollowRequest | TB.CcrUnfollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrUnfollowResponse>
   async unfollow (this: That, params: T.CcrUnfollowRequest | TB.CcrUnfollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrUnfollowResponse, unknown>>

src/api/api/clear_scroll.ts

@@ -40,7 +40,7 @@ interface That { transport: Transport }
 
 /**
   * Clear a scrolling search. Clear the search context and results for a scrolling search.
-  * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html | Elasticsearch API documentation}
+  * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/clear-scroll-api.html | Elasticsearch API documentation}
   */
 export default async function ClearScrollApi (this: That, params?: T.ClearScrollRequest | TB.ClearScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClearScrollResponse>
 export default async function ClearScrollApi (this: That, params?: T.ClearScrollRequest | TB.ClearScrollRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClearScrollResponse, unknown>>