Skip to content

Commit 90fbed0

Browse files
authoredApr 10, 2025
Update URLs for Docs V3 (#4255)
1 parent fea1bf8 commit 90fbed0

File tree

12 files changed

+1412
-1407
lines changed

12 files changed

+1412
-1407
lines changed
 

‎docs/overlays/elasticsearch-openapi-overlays.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ actions:
5353
type: http
5454
description: |
5555
Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
56-
For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)
56+
For examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)
5757
- target: '$'
5858
description: Add document security
5959
update:

‎docs/overlays/elasticsearch-serverless-openapi-overlays.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ actions:
3636
-H "Authorization: ApiKey ${API_KEY}"
3737
```
3838
39-
To get API keys for the Elasticsearch endpoint (${ES_URL}) for a project, refer to [Connect to your Elasticsearch Serverless endpoint](https://www.elastic.co/guide/en/serverless/current/elasticsearch-connecting-to-es-serverless-endpoint.html).
39+
For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to [Get started with Elasticsearch Serverless](https://www.elastic.co/docs/solutions/search/serverless-elasticsearch-get-started).
4040
in: header
4141
name: Authorization
4242
type: apiKey

‎docs/overlays/elasticsearch-shared-overlays.yaml

+24-24
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,21 @@ actions:
3939
4040
This API requires the `manage_connector` privilege or, for read-only endpoints, the `monitor_connector` privilege.
4141
externalDocs:
42-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-tutorial-api.html
43-
description: Check out the connector API tutorial
42+
url: https://www.elastic.co/docs/reference/search-connectors/api-tutorial
43+
description: Check out the connector API tutorial.
4444
- name: ccr
4545
x-displayName: Cross-cluster replication
4646
# D
4747
- name: data stream
4848
x-displayName: Data stream
4949
externalDocs:
5050
description: Learn more about data streams.
51-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
51+
url: https://www.elastic.co/docs/manage-data/data-store/data-streams
5252
- name: document
5353
x-displayName: Document
5454
externalDocs:
5555
description: Learn more about reading and writing documents.
56-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html
56+
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/reading-and-writing-documents
5757
# E
5858
- name: enrich
5959
x-displayName: Enrich
@@ -62,14 +62,14 @@ actions:
6262
description: >
6363
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
6464
externalDocs:
65-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
65+
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql
6666
description: Learn more about EQL search.
6767
- name: esql
6868
x-displayName: ES|QL
6969
description: >
7070
The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, and analyze data stored in Elasticsearch, and in the future in other runtimes.
7171
externalDocs:
72-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
72+
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql
7373
description: Learn more about ES|QL.
7474
# F
7575
- name: features
@@ -83,7 +83,7 @@ actions:
8383
description: >
8484
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
8585
externalDocs:
86-
url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html
86+
url: https://www.elastic.co/docs/explore-analyze/visualize/graph
8787
description: Get started with Graph.
8888
# I
8989
- name: indices
@@ -93,7 +93,7 @@ actions:
9393
- name: ilm
9494
x-displayName: Index lifecycle management
9595
externalDocs:
96-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
96+
url: https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management
9797
description: Learn more about managing the index lifecycle.
9898
- name: inference
9999
x-displayName: Inference
@@ -118,7 +118,7 @@ actions:
118118
description: >
119119
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
120120
externalDocs:
121-
url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
121+
url: https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management
122122
description: Learn more about centralized pipeline management.
123123
# M
124124
- name: ml
@@ -127,19 +127,19 @@ actions:
127127
x-displayName: Machine learning anomaly detection
128128
# description:
129129
externalDocs:
130-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-ad-finding-anomalies.html
130+
url: https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-finding-anomalies
131131
description: Learn more about finding anomalies.
132132
- name: ml data frame
133133
x-displayName: Machine learning data frame analytics
134134
# description:
135135
externalDocs:
136-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-overview.html
136+
url: https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-overview
137137
description: Learn more about data frame analytics.
138138
- name: ml trained model
139139
x-displayName: Machine learning trained model
140140
# description:
141141
externalDocs:
142-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-overview.html
142+
url: https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-overview
143143
description: Learn more about natural language processing.
144144
- name: migration
145145
x-displayName: Migration
@@ -159,7 +159,7 @@ actions:
159159
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
160160
This allows pinning documents for only queries that match a specific term.
161161
externalDocs:
162-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html
162+
url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query
163163
description: Learn more about the rule query.
164164
# R
165165
- name: rollup
@@ -171,7 +171,7 @@ actions:
171171
Use the script support APIs to get a list of supported script contexts and languages.
172172
Use the stored script APIs to manage stored scripts and search templates.
173173
externalDocs:
174-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
174+
url: https://www.elastic.co/docs/explore-analyze/scripting
175175
- name: search
176176
x-displayName: Search
177177
- name: search_application
@@ -185,21 +185,21 @@ actions:
185185
description: >
186186
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
187187
externalDocs:
188-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
188+
url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore
189189
description: Learn more about snapshot and restore operations.
190190
- name: slm
191191
x-displayName: Snapshot lifecycle management
192192
description: >
193193
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
194194
externalDocs:
195-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
195+
url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots
196196
description: Learn more about creating a snapshot.
197197
- name: sql
198198
x-displayName: SQL
199199
description: >
200200
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
201201
externalDocs:
202-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
202+
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql
203203
description: Check out the overview and tutorials for the Elasticsearch SQL features.
204204
- name: synonyms
205205
x-displayName: Synonyms
@@ -223,7 +223,7 @@ actions:
223223
description: >
224224
You can use Watcher to watch for changes or anomalies in your data and perform the necessary actions in response.
225225
externalDocs:
226-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-alerting.html
226+
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher
227227
description: Learn more about Watcher.
228228
# Add x-model and/or abbreviate schemas that should point to other references
229229
- target: "$.components['schemas']['_types.query_dsl.QueryContainer']"
@@ -257,7 +257,7 @@ actions:
257257
x-model: true
258258
externalDocs:
259259
description: Templating a role query
260-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query
260+
url: https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query
261261
- target: "$.components['schemas']['_types.query_dsl.DistanceFeatureQuery']"
262262
description: Add x-model for distance feature query
263263
update:
@@ -1006,7 +1006,7 @@ actions:
10061006
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
10071007
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
10081008
externalDocs:
1009-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
1009+
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
10101010
description: Query DSL
10111011
- target: "$.components['schemas']['ml._types.CategorizationAnalyzerDefinition'].properties.tokenizer"
10121012
description: Remove tokenizer object from ML anomaly detection analysis config
@@ -1027,7 +1027,7 @@ actions:
10271027
Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2).
10281028
`ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`.
10291029
externalDocs:
1030-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
1030+
url: https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference
10311031
description: Tokenizer reference
10321032
- target: "$.components['schemas']['ml._types.DataframeAnalyticsSource'].properties.query"
10331033
description: Remove query object from data frame analytics source
@@ -1044,7 +1044,7 @@ actions:
10441044
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
10451045
By default, this property has the following value: `{"match_all": {}}`.
10461046
externalDocs:
1047-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
1047+
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
10481048
description: Query DSL
10491049
- target: "$.components['schemas']['transform._types.Source'].properties.query"
10501050
description: Remove query object from transform source
@@ -1058,14 +1058,14 @@ actions:
10581058
description: >
10591059
A query clause that retrieves a subset of data from the source index.
10601060
externalDocs:
1061-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
1061+
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
10621062
description: Query DSL
10631063
- target: "$.components['schemas']['_global.search._types.FieldCollapse']"
10641064
description: Add x-model and externalDocs
10651065
update:
10661066
x-model: true
10671067
externalDocs:
1068-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html
1068+
url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results
10691069
# - target: "$.components['schemas']['_global.msearch.MultisearchBody'].properties"
10701070
# description: Add x-model
10711071
# update:

0 commit comments

Comments
 (0)