Skip to content

[docs] Fix various syntax and rendering errors #2776

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -980,6 +980,7 @@ PUT my-index-000001/_doc/1?version=2&version_type=external
"id": "elkbee"
}
}
```

In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.
If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).
Expand Down
56 changes: 0 additions & 56 deletions docs/reference/basic-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,35 +82,27 @@ auth: {
}
```

---

### `maxRetries`

Type: `number`<br>
Default: `3`

Max number of retries for each request.

---

### `requestTimeout`

Type: `number`<br>
Default: `No value`

Max request timeout in milliseconds for each request.

---

### `pingTimeout`

Type: `number`<br>
Default: `3000`

Max ping request timeout in milliseconds for each request.

---

### `sniffInterval`

Type: `number, boolean`<br>
Expand All @@ -122,35 +114,27 @@ Perform a sniff operation every `n` milliseconds.
Sniffing might not be the best solution. Before using the various `sniff` options, review this [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
:::

---

### `sniffOnStart`

Type: `boolean`<br>
Default: `false`

Perform a sniff once the client is started. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).

---

### `sniffEndpoint`

Type: `string`<br>
Default: `'_nodes/_all/http'`

Endpoint to ping during a sniff. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).

---

### `sniffOnConnectionFault`

Type: `boolean`<br>
Default: `false`

Perform a sniff on connection fault. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).

---

### `resurrectStrategy`

Type: `string`<br>
Expand All @@ -159,17 +143,13 @@ Default: `'ping'`
Configure the node resurrection strategy.<br>
Options: `'ping'`, `'optimistic'`, `'none'`

---

### `suggestCompression`

Type: `boolean`<br>
Default: `false`

Adds an `accept-encoding` header to every request.

---

### `compression`

Type: `string, boolean`<br>
Expand All @@ -178,17 +158,13 @@ Default: `false`
Enables gzip request body compression.<br>
Options: `'gzip'`, `false`

---

### `tls`

Type: `http.SecureContextOptions`<br>
Default: `null`

The [tls configuraton](https://nodejs.org/api/tls.html).

---

### `proxy`

Type: `string, URL`<br>
Expand All @@ -208,8 +184,6 @@ const client = new Client({
})
```

---

### `agent`

Type: `http.AgentOptions, function`<br>
Expand Down Expand Up @@ -237,8 +211,6 @@ const client = new Client({
})
```

---

### `nodeFilter`

Type: `function`
Expand All @@ -260,8 +232,6 @@ function defaultNodeFilter (conn) {
}
```

---

### `nodeSelector`

Type: `function`<br>
Expand All @@ -279,8 +249,6 @@ function nodeSelector (connections) {
}
```

---

### `generateRequestId`

Type: `function`<br>
Expand All @@ -297,17 +265,13 @@ function generateRequestId (params, options) {
}
```

---

### `name`

Type: `string, symbol`<br>
Default: `elasticsearch-js`

The name to identify the client instance in the events.

---

### `opaqueIdPrefix`

Type: `string`<br>
Expand All @@ -316,35 +280,27 @@ Default: `null`
A string that will be use to prefix any `X-Opaque-Id` header.
See [`X-Opaque-Id` support](/reference/observability.md#_x_opaque_id_support) for more details.

---

### `headers`

Type: `object`<br>
Default: `{}`

A set of custom headers to send in every request.

---

### `context`

Type: `object`<br>
Default: `null`

A custom object that you can use for observability in your events. It will be merged with the API level context option.

---

### `enableMetaHeader`

Type: `boolean`<br>
Default: `true`

If true, adds an header named `'x-elastic-client-meta'`, containing some minimal telemetry data, such as the client and platform version.

---

### `cloud`

Type: `object`<br>
Expand All @@ -366,43 +322,33 @@ const client = new Client({
})
```

---

### `disablePrototypePoisoningProtection`

Default: `true`

`boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. For more information, refer to [Square Brackets are the Enemy](https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08). If needed, you can enable prototype poisoning protection entirely (`false`) or one of the two checks (`'proto'` or `'constructor'`). For performance reasons, it is disabled by default. To learn more, refer to the [`secure-json-parse` documentation](https://github.com/fastify/secure-json-parse).

---

### `caFingerprint`

Type: `string`<br>
Default: `null`

If configured, verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint. Only accepts SHA256 digest fingerprints.

---

### `maxResponseSize`

Type: `number`<br>
Default: `null`

When configured, `maxResponseSize` verifies that the uncompressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.

---

### `maxCompressedResponseSize`

Type: `number`<br>
Default: `null`

When configured, `maxCompressedResponseSize` verifies that the compressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxCompressedResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.

---

### `redaction`

Type: `object`<br>
Expand All @@ -414,8 +360,6 @@ Options for how to redact potentially sensitive data from metadata attached to `
[Read about redaction](/reference/advanced-config.md#redaction) for more details
::::

---

### `serverMode`

Type: `string`<br>
Expand Down
Loading