Skip to content

Commit 48b7672

Browse files
[Backport 8.16] [OpenAPI] Edits connector API summaries (#3072)
1 parent cfcc3f4 commit 48b7672

30 files changed

+259
-171
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ actions:
1313
1414
## Documentation source and versions
1515
16-
This documentation is derived from the `8.x` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
16+
This documentation is derived from the `8.16` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
1717
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
1818
x-doc-license:
1919
name: Attribution-NonCommercial-NoDerivatives 4.0 International

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,28 @@ actions:
3535
3636
Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure:
3737
38-
* Native connectors are a managed service on Elastic Cloud
39-
* Connector clients are self-managed on your infrastructure
38+
* Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud
39+
40+
* Self-managed connectors (Connector clients) are self-managed on your infrastructure.
41+
4042
4143
This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid.
4244
externalDocs:
43-
url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html
44-
description: To get started with Connector APIs, check out the tutorial.
45+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/es-connectors-tutorial-api.html
46+
description: Connector API tutorial
4547
- name: ccr
4648
x-displayName: Cross-cluster replication
4749
# D
4850
- name: data stream
4951
x-displayName: Data stream
5052
externalDocs:
5153
description: Data stream overview
52-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
54+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html
5355
- name: document
5456
x-displayName: Document
5557
externalDocs:
5658
description: Reading and writing documents
57-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html
59+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-replication.html
5860
- name: mget
5961
x-displayName: Document - Multi get
6062
- name: mtermvectors
@@ -71,14 +73,14 @@ actions:
7173
description: >
7274
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
7375
externalDocs:
74-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
76+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql.html
7577
description: EQL search
7678
- name: esql
7779
x-displayName: ES|QL
7880
description: >
7981
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.
8082
externalDocs:
81-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
83+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql.html
8284
description: ES|QL overview and tutorials
8385
# F
8486
- name: features
@@ -92,7 +94,7 @@ actions:
9294
description: >
9395
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
9496
externalDocs:
95-
url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html
97+
url: https://www.elastic.co/guide/en/kibana/8.16/xpack-graph.html
9698
description: Getting started with Graph
9799
# I
98100
- name: indices
@@ -104,7 +106,7 @@ actions:
104106
- name: ilm
105107
x-displayName: Index lifecycle management
106108
externalDocs:
107-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
109+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-lifecycle-management.html
108110
description: Manage the index lifecycle
109111
- name: inference
110112
x-displayName: Inference
@@ -126,7 +128,7 @@ actions:
126128
description: >
127129
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
128130
externalDocs:
129-
url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
131+
url: https://www.elastic.co/guide/en/logstash/8.16/logstash-centralized-pipeline-management.html
130132
description: Centralized pipeline management
131133
# M
132134
- name: ml
@@ -135,19 +137,19 @@ actions:
135137
x-displayName: Machine learning anomaly detection
136138
# description:
137139
externalDocs:
138-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-ad-finding-anomalies.html
140+
url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-ad-finding-anomalies.html
139141
description: Finding anomalies
140142
- name: ml data frame
141143
x-displayName: Machine learning data frame analytics
142144
# description:
143145
externalDocs:
144-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-overview.html
146+
url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-dfa-overview.html
145147
description: Data frame analytics overview
146148
- name: ml trained model
147149
x-displayName: Machine learning trained model
148150
# description:
149151
externalDocs:
150-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-overview.html
152+
url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-nlp-overview.html
151153
description: Natural language processing overview
152154
- name: migration
153155
x-displayName: Migration
@@ -167,7 +169,7 @@ actions:
167169
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
168170
This allows pinning documents for only queries that match a specific term.
169171
externalDocs:
170-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html
172+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl-rule-query.html
171173
description: Rule query
172174
# R
173175
- name: rollup
@@ -200,21 +202,21 @@ actions:
200202
description: >
201203
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
202204
externalDocs:
203-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
205+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshot-restore.html
204206
description: Snapshot and restore
205207
- name: slm
206208
x-displayName: Snapshot lifecycle management
207209
description: >
208210
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
209211
externalDocs:
210-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
212+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshots-take-snapshot.html
211213
description: Create a snapshot
212214
- name: sql
213215
x-displayName: SQL
214216
description: >
215217
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
216218
externalDocs:
217-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
219+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/xpack-sql.html
218220
description: An overview and tutorials for the Elasticsearch SQL features
219221
- name: synonyms
220222
x-displayName: Synonyms
@@ -250,7 +252,7 @@ actions:
250252
description: >
251253
Character filters that are used to preprocess characters before they are passed to the tokenizer.
252254
externalDocs:
253-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html
255+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-charfilters.html
254256
description: Character filters reference
255257
- target: "$.components['schemas']['_types.analysis:Tokenizer'].oneOf"
256258
description: Remove existing oneOf definition for tokenizer
@@ -262,7 +264,7 @@ actions:
262264
description: >
263265
A tokenizer to use to convert text into tokens.
264266
externalDocs:
265-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
267+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
266268
description: Tokenizer reference
267269
- target: "$.components['schemas']['_types.analysis:TokenFilter'].oneOf"
268270
description: Remove existing oneOf definition for tokenfilter
@@ -274,15 +276,15 @@ actions:
274276
description: >
275277
Token filters that are applied after the tokenizer.
276278
externalDocs:
277-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html
279+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenfilters.html
278280
description: Token filter reference
279281
- target: "$.components['schemas']['security._types:RoleTemplateScript']"
280282
description: Add x-model where recommended by Bump.sh
281283
update:
282284
x-model: true
283285
externalDocs:
284286
description: Templating a role query
285-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query
287+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/field-and-document-access-control.html#templating-role-query
286288
# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
287289
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
288290
description: Remove query object from anomaly detection datafeed
@@ -299,7 +301,7 @@ actions:
299301
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
300302
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
301303
externalDocs:
302-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
304+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
303305
description: Query DSL
304306
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
305307
description: Remove tokenizer object from ML anomaly detection analysis config
@@ -320,7 +322,7 @@ actions:
320322
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).
321323
`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`.
322324
externalDocs:
323-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
325+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
324326
description: Tokenizer reference
325327
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
326328
description: Remove query object from data frame analytics source
@@ -337,7 +339,7 @@ actions:
337339
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
338340
By default, this property has the following value: `{"match_all": {}}`.
339341
externalDocs:
340-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
342+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
341343
description: Query DSL
342344
- target: "$.components['schemas']['transform._types:Source'].properties.query"
343345
description: Remove query object from transform source
@@ -351,14 +353,14 @@ actions:
351353
description: >
352354
A query clause that retrieves a subset of data from the source index.
353355
externalDocs:
354-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
356+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
355357
description: Query DSL
356358
- target: "$.components['schemas']['_global.search._types:FieldCollapse']"
357359
description: Add x-model and externalDocs
358360
update:
359361
x-model: true
360362
externalDocs:
361-
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/collapse-search-results.html
363+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/collapse-search-results.html
362364
- target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties"
363365
description: Add x-model
364366
update:

0 commit comments

Comments
 (0)