[Backport 8.16] [OpenAPI] Edits connector API summaries (#3072)

docs/overlays/elasticsearch-openapi-overlays.yaml

@@ -13,7 +13,7 @@ actions:
         
         ## Documentation source and versions
         
-        This documentation is derived from the `8.x` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
+        This documentation is derived from the `8.16` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
         It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
       x-doc-license:
         name: Attribution-NonCommercial-NoDerivatives 4.0 International

docs/overlays/elasticsearch-shared-overlays.yaml

@@ -35,26 +35,28 @@ actions:
             
             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:
             
-            * Native connectors are a managed service on Elastic Cloud
-            * Connector clients are self-managed on your infrastructure
+            * Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud
+            
+            * Self-managed connectors (Connector clients) are self-managed on your infrastructure.
+            
             
             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.
           externalDocs:
-            url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html
-            description: To get started with Connector APIs, check out the tutorial.
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/es-connectors-tutorial-api.html
+            description: Connector API tutorial
         - name: ccr
           x-displayName: Cross-cluster replication
       # D
         - name: data stream
           x-displayName: Data stream
           externalDocs:
             description: Data stream overview 
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html
         - name: document
           x-displayName: Document
           externalDocs:
             description: Reading and writing documents
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-replication.html
         - name: mget
           x-displayName: Document - Multi get
         - name: mtermvectors
@@ -71,14 +73,14 @@ actions:
           description: >
             Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
           externalDocs:
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql.html
             description: EQL search
         - name: esql
           x-displayName: ES|QL
           description: >
             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.
           externalDocs:
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql.html
             description: ES|QL overview and tutorials
       # F
         - name: features
@@ -92,7 +94,7 @@ actions:
           description: >
             The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
           externalDocs:
-            url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html
+            url: https://www.elastic.co/guide/en/kibana/8.16/xpack-graph.html
             description: Getting started with Graph
       # I
         - name: indices
@@ -104,7 +106,7 @@ actions:
         - name: ilm
           x-displayName: Index lifecycle management
           externalDocs:
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-lifecycle-management.html
             description: Manage the index lifecycle
         - name: inference
           x-displayName: Inference
@@ -126,7 +128,7 @@ actions:
           description: >
             Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
           externalDocs:
-            url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
+            url: https://www.elastic.co/guide/en/logstash/8.16/logstash-centralized-pipeline-management.html
             description: Centralized pipeline management
       # M
         - name: ml
@@ -135,19 +137,19 @@ actions:
           x-displayName: Machine learning anomaly detection
           # description:
           externalDocs:
-            url: https://www.elastic.co/guide/en/machine-learning/current/ml-ad-finding-anomalies.html
+            url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-ad-finding-anomalies.html
             description: Finding anomalies
         - name: ml data frame
           x-displayName: Machine learning data frame analytics
           # description:
           externalDocs:
-            url: https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-overview.html
+            url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-dfa-overview.html
             description: Data frame analytics overview
         - name: ml trained model
           x-displayName: Machine learning trained model
           # description:
           externalDocs:
-            url: https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-overview.html
+            url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-nlp-overview.html
             description: Natural language processing overview
         - name: migration
           x-displayName: Migration
@@ -167,7 +169,7 @@ actions:
             If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
             This allows pinning documents for only queries that match a specific term.
           externalDocs:
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl-rule-query.html
             description: Rule query
       # R
         - name: rollup
@@ -200,21 +202,21 @@ actions:
           description: >
             Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
           externalDocs:
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshot-restore.html
             description: Snapshot and restore
         - name: slm
           x-displayName: Snapshot lifecycle management
           description: >
             Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
           externalDocs:
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshots-take-snapshot.html
             description: Create a snapshot
         - name: sql
           x-displayName: SQL
           description: >
             Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
           externalDocs:
-            url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
+            url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/xpack-sql.html
             description: An overview and tutorials for the Elasticsearch SQL features
         - name: synonyms
           x-displayName: Synonyms
@@ -250,7 +252,7 @@ actions:
       description: >
         Character filters that are used to preprocess characters before they are passed to the tokenizer.
       externalDocs:
-        url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html
+        url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-charfilters.html
         description: Character filters reference
   - target: "$.components['schemas']['_types.analysis:Tokenizer'].oneOf"
     description: Remove existing oneOf definition for tokenizer
@@ -262,7 +264,7 @@ actions:
       description: >
         A tokenizer to use to convert text into tokens.
       externalDocs:
-        url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
+        url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
         description: Tokenizer reference
   - target: "$.components['schemas']['_types.analysis:TokenFilter'].oneOf"
     description: Remove existing oneOf definition for tokenfilter
@@ -274,15 +276,15 @@ actions:
       description: >
         Token filters that are applied after the tokenizer.
       externalDocs:
-        url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html
+        url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenfilters.html
         description: Token filter reference
   - target: "$.components['schemas']['security._types:RoleTemplateScript']"
     description: Add x-model where recommended by Bump.sh
     update:
       x-model: true
       externalDocs:
         description: Templating a role query
-        url: https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query
+        url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/field-and-document-access-control.html#templating-role-query
 # Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
   - target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
     description: Remove query object from anomaly detection datafeed
@@ -299,7 +301,7 @@ actions:
           All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
           By default, this property has the following value: `{"match_all": {"boost": 1}}`.
         externalDocs:
-          url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
+          url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
           description: Query DSL
   - target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
     description: Remove tokenizer object from ML anomaly detection analysis config
@@ -320,7 +322,7 @@ actions:
           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).
           `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`.
         externalDocs:
-          url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
+          url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
           description: Tokenizer reference
   - target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
     description: Remove query object from data frame analytics source
@@ -337,7 +339,7 @@ actions:
           All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
           By default, this property has the following value: `{"match_all": {}}`.
         externalDocs:
-          url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
+          url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
           description: Query DSL
   - target: "$.components['schemas']['transform._types:Source'].properties.query"
     description: Remove query object from transform source
@@ -351,14 +353,14 @@ actions:
         description: >
           A query clause that retrieves a subset of data from the source index.
         externalDocs:
-          url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
+          url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
           description: Query DSL
   - target: "$.components['schemas']['_global.search._types:FieldCollapse']"
     description: Add x-model and externalDocs
     update:
       x-model: true
       externalDocs:
-        url: https://www.elastic.co/guide/en/elasticsearch/reference/master/collapse-search-results.html
+        url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/collapse-search-results.html
   - target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties"
     description: Add x-model
     update: