Skip to content

Commit 6cb0ce6

Browse files
lcawlleemthompo
andauthored
[OpenAPI] Edits connector API summaries (#3051)
Co-authored-by: Liam Thompson <[email protected]>
1 parent e46f571 commit 6cb0ce6

29 files changed

+248
-160
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,15 @@ 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/master/es-connectors-tutorial-api.html
46+
description: Connector API tutorial
4547
- name: ccr
4648
x-displayName: Cross-cluster replication
4749
# D
@@ -63,14 +65,14 @@ actions:
6365
description: >
6466
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
6567
externalDocs:
66-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
68+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/eql.html
6769
description: EQL search
6870
- name: esql
6971
x-displayName: ES|QL
7072
description: >
7173
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.
7274
externalDocs:
73-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
75+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/esql.html
7476
description: ES|QL overview and tutorials
7577
# F
7678
- name: features
@@ -84,7 +86,7 @@ actions:
8486
description: >
8587
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
8688
externalDocs:
87-
url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html
89+
url: https://www.elastic.co/guide/en/kibana/master/xpack-graph.html
8890
description: Getting started with Graph
8991
# I
9092
- name: indices
@@ -94,7 +96,7 @@ actions:
9496
- name: ilm
9597
x-displayName: Index lifecycle management
9698
externalDocs:
97-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
99+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-management.html
98100
description: Manage the index lifecycle
99101
- name: inference
100102
x-displayName: Inference
@@ -116,7 +118,7 @@ actions:
116118
description: >
117119
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
118120
externalDocs:
119-
url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
121+
url: https://www.elastic.co/guide/en/logstash/master/logstash-centralized-pipeline-management.html
120122
description: Centralized pipeline management
121123
# M
122124
- name: ml
@@ -157,7 +159,7 @@ actions:
157159
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
158160
This allows pinning documents for only queries that match a specific term.
159161
externalDocs:
160-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html
162+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl-rule-query.html
161163
description: Rule query
162164
# R
163165
- name: rollup
@@ -178,21 +180,21 @@ actions:
178180
description: >
179181
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
180182
externalDocs:
181-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
183+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshot-restore.html
182184
description: Snapshot and restore
183185
- name: slm
184186
x-displayName: Snapshot lifecycle management
185187
description: >
186188
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
187189
externalDocs:
188-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
190+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html
189191
description: Create a snapshot
190192
- name: sql
191193
x-displayName: SQL
192194
description: >
193195
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
194196
externalDocs:
195-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
197+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/xpack-sql.html
196198
description: An overview and tutorials for the Elasticsearch SQL features
197199
- name: synonyms
198200
x-displayName: Synonyms
@@ -994,7 +996,7 @@ actions:
994996
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
995997
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
996998
externalDocs:
997-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
999+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html
9981000
description: Query DSL
9991001
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
10001002
description: Remove tokenizer object from ML anomaly detection analysis config
@@ -1015,7 +1017,7 @@ actions:
10151017
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).
10161018
`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`.
10171019
externalDocs:
1018-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
1020+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/analysis-tokenizers.html
10191021
description: Tokenizer reference
10201022
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
10211023
description: Remove query object from data frame analytics source
@@ -1032,7 +1034,7 @@ actions:
10321034
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
10331035
By default, this property has the following value: `{"match_all": {}}`.
10341036
externalDocs:
1035-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
1037+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html
10361038
description: Query DSL
10371039
- target: "$.components['schemas']['transform._types:Source'].properties.query"
10381040
description: Remove query object from transform source
@@ -1046,7 +1048,7 @@ actions:
10461048
description: >
10471049
A query clause that retrieves a subset of data from the source index.
10481050
externalDocs:
1049-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
1051+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html
10501052
description: Query DSL
10511053
# Examples
10521054
- target: "$.components['requestBodies']['async_search.submit']"

output/openapi/elasticsearch-openapi.json

Lines changed: 44 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)