Skip to content
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.

Sign up for GitHub

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

[docs] Clean up cross-repo links #2640

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[docs] Clean up cross-repo links #2640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6a3833
clean up cross-repo links
colleenmcginnis Feb 28, 2025
7eb6f79
add docs-content to cross_links
colleenmcginnis Feb 28, 2025
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/docset.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ project: 'Node.js client'
exclude:
- examples/proxy/README.md
cross_links:
- docs-content
- elasticsearch
toc:
- toc: reference
Expand Down
10 changes: 5 additions & 5 deletions docs/reference/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,7 +764,7 @@ Get script contexts.

Get a list of supported script contexts and their methods.

[Endpoint documentation](elasticsearch://docs/reference/scripting-languages/painless/painless-contexts.md)
[Endpoint documentation](elasticsearch://reference/scripting-languages/painless/painless-contexts.md)

```ts
client.getScriptContext()
Expand Down Expand Up @@ -1534,7 +1534,7 @@ The API uses several *contexts*, which control how scripts are run, what variabl

Each context requires a script, but additional parameters depend on the context you’re using for that script.

[Endpoint documentation](elasticsearch://docs/reference/scripting-languages/painless/painless-api-examples.md)
[Endpoint documentation](elasticsearch://reference/scripting-languages/painless/painless-api-examples.md)

```ts
client.scriptsPainlessExecute({ ... })
Expand Down Expand Up @@ -5261,7 +5261,7 @@ client.ilm.stop({ ... })

Add an index block. Limits the operations allowed on an index by blocking specific operation types.

[Index block settings](elasticsearch://docs/reference/elasticsearch/index-settings/index-block.md)
[Index block settings](elasticsearch://reference/elasticsearch/index-settings/index-block.md)

```ts
client.indices.addBlock({ index, block })
Expand Down Expand Up @@ -7375,7 +7375,7 @@ client.ingest.deletePipeline({ id })

Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.

[Endpoint documentation](elasticsearch://docs/reference/ingestion-tools/enrich-processor/geoip-processor.md)
[Endpoint documentation](elasticsearch://reference/ingestion-tools/enrich-processor/geoip-processor.md)

```ts
client.ingest.geoIpStats()
Expand Down Expand Up @@ -7446,7 +7446,7 @@ client.ingest.getPipeline({ ... })

Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.

[Endpoint documentation](elasticsearch://docs/reference/ingestion-tools/enrich-processor/grok-processor.md)
[Endpoint documentation](elasticsearch://reference/ingestion-tools/enrich-processor/grok-processor.md)

```ts
client.ingest.processorGrok()
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/connecting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Running {{es}} without security enabled is not recommended.
::::


If your cluster is configured with [security explicitly disabled](elasticsearch://docs/reference/elasticsearch/configuration-reference/security-settings.md) then you can connect via HTTP:
If your cluster is configured with [security explicitly disabled](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md) then you can connect via HTTP:

```js
const { Client } = require('@elastic/elasticsearch')
Expand Down Expand Up @@ -332,7 +332,7 @@ The supported request specific options are:
| Option | Description |
| --- | ----------- |
| `ignore` | `number[]` -  HTTP status codes which should not be considered errors for this request.<br>*Default:* `null` |
| `requestTimeout` | `number` or `string` - Max request timeout for the request in milliseconds. This overrides the client default, which is to not time out at all. See [Elasticsearch best practices for HTML clients](elasticsearch://docs/reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more info.<br>_Default:* No timeout |
| `requestTimeout` | `number` or `string` - Max request timeout for the request in milliseconds. This overrides the client default, which is to not time out at all. See [Elasticsearch best practices for HTML clients](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more info.<br>_Default:* No timeout |
| `retryOnTimeout` | `boolean` - Retry requests that have timed out.*Default:* `false` |
| `maxRetries` | `number` - Max number of retries for the request, it overrides the client default.<br>*Default:* `3` |
| `compression` | `string` or `boolean` - Enables body compression for the request.<br>*Options:* `false`, `'gzip'`<br>*Default:* `false` |
Expand All @@ -341,7 +341,7 @@ The supported request specific options are:
|`querystring` | `object` - Custom querystring for the request.<br>*Default:* `null` |
| `id` | `any` - Custom request ID. *(overrides the top level request id generator)*<br>*Default:* `null` |
| `context` | `any` - Custom object per request. *(you can use it to pass data to the clients events)*<br>*Default:* `null` |
| `opaqueId` | `string` - Set the `X-Opaque-Id` HTTP header. See [X-Opaque-Id HTTP header](elasticsearch://docs/reference/elasticsearch/rest-apis/api-conventions.md#x-opaque-id) *Default:* `null` |
| `opaqueId` | `string` - Set the `X-Opaque-Id` HTTP header. See [X-Opaque-Id HTTP header](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#x-opaque-id) *Default:* `null` |
| `maxResponseSize` | `number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENTGH<br>*Default:* `null` |
| `maxCompressedResponseSize` | `number` - When configured, it verifies that the compressed response size is lower than the configured number, if it’s higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENTGH<br>*Default:* `null` |
| `signal` | `AbortSignal` - The AbortSignal instance to allow request abortion.<br>*Default:* `null` |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ child.search({

## X-Opaque-Id support [_x_opaque_id_support]

To improve observability, the client offers an easy way to configure the `X-Opaque-Id` header. If you set the `X-Opaque-Id` in a specific request, this allows you to discover this identifier in the [deprecation logs](docs-content://deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md#deprecation-logging), helps you with [identifying search slow log origin](elasticsearch://docs/reference/elasticsearch/index-settings/slow-log.md) as well as [identifying running tasks](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks).
To improve observability, the client offers an easy way to configure the `X-Opaque-Id` header. If you set the `X-Opaque-Id` in a specific request, this allows you to discover this identifier in the [deprecation logs](docs-content://deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md#deprecation-logging), helps you with [identifying search slow log origin](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) as well as [identifying running tasks](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks).

The `X-Opaque-Id` should be configured in each request, for doing that you can use the `opaqueId` option, as you can see in the following example. The resulting header will be `{ 'X-Opaque-Id': 'my-search' }`.

Expand Down