From ab0b2b28483c57bebc461abde2a3710c09101fb6 Mon Sep 17 00:00:00 2001 From: Andrei Dan Date: Mon, 16 Oct 2023 14:37:08 +0100 Subject: [PATCH] Update spec for the GET _data_stream API --- output/schema/schema.json | 68 ++++++++++++++++++++-- output/typescript/types.ts | 5 ++ specification/indices/_types/DataStream.ts | 20 +++++++ 3 files changed, 89 insertions(+), 4 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 96dd8f1e48..6e828f28c6 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -110079,6 +110079,30 @@ } } }, + { + "description": "Name of the lifecycle system that'll manage the next generation of the data stream.", + "name": "next_generation_managed_by", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.", + "name": "prefer_ilm", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "description": "Array of objects containing information about the data stream’s backing indices.\nThe last item in this array contains information about the stream’s current write index.", "name": "indices", @@ -110197,7 +110221,7 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L32-L96" + "specLocation": "indices/_types/DataStream.ts#L32-L104" }, { "kind": "interface", @@ -110229,9 +110253,45 @@ "namespace": "_types" } } + }, + { + "description": "Name of the current ILM lifecycle policy configured for this backing index.", + "name": "ilm_policy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "description": "Name of the lifecycle system that's currently managing this backing index.", + "name": "managed_by", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Indicates if ILM should take precedence over DSL in case both are configured to manage this index.", + "name": "prefer_ilm", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "indices/_types/DataStream.ts#L105-L114" + "specLocation": "indices/_types/DataStream.ts#L113-L134" }, { "description": "Data lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", @@ -110478,7 +110538,7 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L98-L103" + "specLocation": "indices/_types/DataStream.ts#L106-L111" }, { "kind": "interface", @@ -110499,7 +110559,7 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L116-L118" + "specLocation": "indices/_types/DataStream.ts#L136-L138" }, { "kind": "interface", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 8f6166c0cc..f01534ec88 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -9658,6 +9658,8 @@ export interface IndicesDataStream { generation: integer hidden: boolean ilm_policy?: Name + next_generation_managed_by: string + prefer_ilm: boolean indices: IndicesDataStreamIndex[] lifecycle?: IndicesDataStreamLifecycleWithRollover name: DataStreamName @@ -9671,6 +9673,9 @@ export interface IndicesDataStream { export interface IndicesDataStreamIndex { index_name: IndexName index_uuid: Uuid + ilm_policy?: Name + managed_by: string + prefer_ilm: boolean } export interface IndicesDataStreamLifecycle { diff --git a/specification/indices/_types/DataStream.ts b/specification/indices/_types/DataStream.ts index d8df7a6413..031e7dbdb6 100644 --- a/specification/indices/_types/DataStream.ts +++ b/specification/indices/_types/DataStream.ts @@ -54,6 +54,14 @@ export class DataStream { * NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API. */ ilm_policy?: Name + /** + * Name of the lifecycle system that'll manage the next generation of the data stream. + */ + next_generation_managed_by: string + /** + * Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + */ + prefer_ilm: boolean /** * Array of objects containing information about the data stream’s backing indices. * The last item in this array contains information about the stream’s current write index. @@ -111,6 +119,18 @@ export class DataStreamIndex { * Universally unique identifier (UUID) for the index. */ index_uuid: Uuid + /** + * Name of the current ILM lifecycle policy configured for this backing index. + */ + ilm_policy?: Name + /** + * Name of the lifecycle system that's currently managing this backing index. + */ + managed_by: string + /** + * Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + */ + prefer_ilm: boolean } export class DataStreamVisibility {