From e7a13b2a4ed24cab40d5af97342c564eaf405dea Mon Sep 17 00:00:00 2001 From: kosabogi <105062005+kosabogi@users.noreply.github.com> Date: Mon, 8 Sep 2025 12:18:27 +0200 Subject: [PATCH] Adds description for the 'frequency' parameter in responses (#5266) * Adds frequency parameter description to the Datafeed.ts file * Adds missing description * Fixes code style errpr (cherry picked from commit 742151efd5e9f56f61313a3325d0fe949d573fc4) --- specification/ml/_types/Datafeed.ts | 3 +++ specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts | 3 +++ 2 files changed, 6 insertions(+) diff --git a/specification/ml/_types/Datafeed.ts b/specification/ml/_types/Datafeed.ts index dac7a558d1..bed5f5ea35 100644 --- a/specification/ml/_types/Datafeed.ts +++ b/specification/ml/_types/Datafeed.ts @@ -43,6 +43,9 @@ export class Datafeed { authorization?: DatafeedAuthorization chunking_config?: ChunkingConfig datafeed_id: Id + /** + * The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + */ frequency?: Duration indices: string[] indexes?: string[] diff --git a/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts b/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts index aa103b2085..8118415acb 100644 --- a/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts +++ b/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts @@ -35,6 +35,9 @@ export class Response { chunking_config: ChunkingConfig delayed_data_check_config?: DelayedDataCheckConfig datafeed_id: Id + /** + * The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + */ frequency?: Duration indices: string[] indices_options?: IndicesOptions