Merge branch 'main' into inference-service-task-types

Author: kosabogi

docs/overlays/elasticsearch-openapi-overlays.yaml

@@ -60,4 +60,9 @@ actions:
       security:
         - apiKeyAuth: []
         - basicAuth: []
-        - bearerAuth: []
+        - bearerAuth: []
+# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
+  - target: "$.components['schemas']['_types.aggregations.RandomSamplerAggregation']"
+    description: Add x-model
+    update:
+      x-model: true

docs/overlays/elasticsearch-shared-overlays.yaml

@@ -915,10 +915,6 @@ actions:
     description: Add x-model
     update:
       x-model: true
-  - target: "$.components['schemas']['_types.aggregations.RandomSamplerAggregation']"
-    description: Add x-model
-    update:
-      x-model: true
   - target: "$.components['schemas']['_types.aggregations.RareTermsAggregation']"
     description: Add x-model
     update:
@@ -1066,6 +1062,16 @@ actions:
       x-model: true
       externalDocs:
         url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results
+  - target: "$.components['schemas']['indices._types.IndexSettings']"
+    description: Add x-model and externalDocs for IndexSettings component
+    update:
+      x-model: true
+      externalDocs:
+        description: Index settings
+        url: https://www.elastic.co/docs/reference/elasticsearch/index-settings/
+  - target: "$.components['schemas']['indices._types.IndexSettings'].properties"
+    description: Remove properties IndexSettings object
+    remove: true
   # - target: "$.components['schemas']['_global.msearch.MultisearchBody'].properties"
   #   description: Add x-model
   #   update:
@@ -1082,3 +1088,7 @@ actions:
         - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml"
         - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml"
         - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml"
+# Remove long lists of enum values
+  - target: "$.components['schemas']['cat._types.CatAnomalyDetectorColumn'].enum"
+    description: Remove enum array
+    remove: true

output/openapi/elasticsearch-openapi.json

@@ -282,6 +282,7 @@ index-modules,https://www.elastic.co/docs/reference/elasticsearch/index-settings
 index,https://www.elastic.co/docs/get-started
 indexing-buffer,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/indexing-buffer-settings
 index-modules-merge,https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge
+index-settings,https://www.elastic.co/docs/reference/elasticsearch/index-settings/
 index-templates,https://www.elastic.co/docs/manage-data/data-store/templates
 index-templates-exist,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template
 index-templates-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template

output/openapi/elasticsearch-serverless-openapi.json

@@ -30,10 +30,6 @@
         "default": "open",
         "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
       },
-      "include_defaults": {
-        "type": "boolean",
-        "description": "Return all relevant default configurations for the data stream (default: false)"
-      },
       "master_timeout": {
         "type": "time",
         "description": "Specify timeout for connection to master"

output/schema/schema-serverless.json

@@ -19,6 +19,7 @@
 
 import { AliasDefinition } from '@indices/_types/AliasDefinition'
 import { DataStreamLifecycleWithRollover } from '@indices/_types/DataStreamLifecycle'
+import { DataStreamOptionsTemplate } from '@indices/_types/DataStreamOptions'
 import { IndexSettings } from '@indices/_types/IndexSettings'
 import { Dictionary } from '@spec_utils/Dictionary'
 import { IndexName, Metadata, Name, VersionNumber } from '@_types/common'
@@ -52,4 +53,9 @@ export class ComponentTemplateSummary {
    * @availability serverless stability=stable
    */
   lifecycle?: DataStreamLifecycleWithRollover
+  /**
+   * @availability stack since=8.19.0 stability=stable
+   * @availability serverless stability=stable
+   */
+  data_stream_options?: DataStreamOptionsTemplate | null
 }

output/schema/schema.json

@@ -0,0 +1,90 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Duration } from '@_types/Time'
+
+/**
+ * Data stream failure store contains the configuration of the failure store for a given data stream.
+ */
+export class DataStreamFailureStore {
+  /**
+   * If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store
+   * that's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will
+   * not remove any existing data from the failure store.
+   * @server_default true
+   */
+  enabled?: boolean
+  /**
+   * If defined, it specifies the lifecycle configuration for the failure store of this data stream.
+   */
+  lifecycle?: FailureStoreLifecycle
+}
+
+/**
+ * Template equivalent of DataStreamFailureStore that allows nullable values.
+ */
+export class DataStreamFailureStoreTemplate {
+  /**
+   * If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store
+   * that's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will
+   * not remove any existing data from the failure store.
+   * @server_default true
+   */
+  enabled?: boolean | null
+  /**
+   * If defined, it specifies the lifecycle configuration for the failure store of this data stream.
+   */
+  lifecycle?: FailureStoreLifecycleTemplate | null
+}
+
+/**
+ * The failure store lifecycle configures the data stream lifecycle configuration for failure indices.
+ */
+export class FailureStoreLifecycle {
+  /**
+   * If defined, every document added to this data stream will be stored at least for this time frame.
+   * Any time after this duration the document could be deleted.
+   * When empty, every document in this data stream will be stored indefinitely.
+   */
+  data_retention?: Duration
+  /**
+   * If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
+   * that's disabled (enabled: `false`) will have no effect on the data stream.
+   * @server_default true
+   */
+  enabled?: boolean
+}
+
+/**
+ * Template equivalent of FailureStoreLifecycle that allows nullable values.
+ */
+export class FailureStoreLifecycleTemplate {
+  /**
+   * If defined, every document added to this data stream will be stored at least for this time frame.
+   * Any time after this duration the document could be deleted.
+   * When empty, every document in this data stream will be stored indefinitely.
+   */
+  data_retention?: Duration | null
+  /**
+   * If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
+   * that's disabled (enabled: `false`) will have no effect on the data stream.
+   * @server_default true
+   */
+  enabled?: boolean
+}

output/typescript/types.ts

@@ -0,0 +1,41 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import {
+  DataStreamFailureStore,
+  DataStreamFailureStoreTemplate
+} from '@indices/_types/DataStreamFailureStore'
+
+/**
+ * Data stream options contain the configuration of data stream level features for a given data stream, for example,
+ * the failure store configuration.
+ */
+export class DataStreamOptions {
+  /**
+   * If defined, it specifies configuration for the failure store of this data stream.
+   */
+  failure_store?: DataStreamFailureStore
+}
+
+/**
+ * Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.
+ */
+export class DataStreamOptionsTemplate {
+  failure_store?: DataStreamFailureStoreTemplate | null
+}

specification/_doc_ids/table.csv

@@ -69,7 +69,7 @@ export class RetentionLease {
 
 /**
  * @doc_id index-modules-settings
- *
+ * @ext_doc_id index-settings
  * @behavior_meta AdditionalProperties fieldname=other_settings description="Additional settings not covered in this type."
  */
 export class IndexSettings

specification/_json_spec/indices.get_data_stream_options.json

@@ -18,6 +18,7 @@
  */
 
 import { DataStreamLifecycleWithRollover } from '@indices/_types/DataStreamLifecycle'
+import { DataStreamOptionsTemplate } from '@indices/_types/DataStreamOptions'
 import { Dictionary } from '@spec_utils/Dictionary'
 import { IndexName, Metadata, Name, Names, VersionNumber } from '@_types/common'
 import { TypeMapping } from '@_types/mapping/TypeMapping'
@@ -115,4 +116,9 @@ export class IndexTemplateSummary {
    * @availability serverless stability=stable
    */
   lifecycle?: DataStreamLifecycleWithRollover
+  /**
+   * @availability stack since=8.19.0 stability=stable
+   * @availability serverless stability=stable
+   */
+  data_stream_options?: DataStreamOptionsTemplate | null
 }