Parameter descriptions not propagated to response bodies in ML anomaly detection APIs

[kosabogi]

As mentioned in this issue, the frequency parameter's description (and possibly other parameter descriptions) was missing from the Machine Learning Anomaly Detection APIs.

After this issue was resolved, the parameter descriptions are now properly propagated, but only for request bodies, not for responses.

Details

I wanted to verify that all parameter descriptions are now present before closing the this issue. While checking every endpoint where the frequency parameter appears, I found that:

In request bodies: The parameter description is correctly displayed:

In response bodies: The parameter description is missing, and only the generic "Duration" type description is shown:

Expected behavior

The parameter descriptions, including frequency, should be consistently displayed in both request and response sections.

[pquentin]

In response bodies: The parameter description is missing, and only the generic "Duration" type description is shown:

In which API did you expect frequency with a parameter description? The only one I found is ml.update_datafeed, and there is indeed no description in the spec itself, which suggests this is not a propagation bug but a specification bug.

elasticsearch-specification/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts

Lines 31 to 49 in 98ec7ac

	export class Response {
	body: {
	authorization?: DatafeedAuthorization
	aggregations?: Dictionary<string, AggregationContainer>
	chunking_config: ChunkingConfig
	delayed_data_check_config?: DelayedDataCheckConfig
	datafeed_id: Id
	frequency?: Duration
	indices: string[]
	indices_options?: IndicesOptions
	job_id: Id
	max_empty_searches?: integer
	query: QueryContainer
	query_delay: Duration
	runtime_mappings?: RuntimeFields
	script_fields?: Dictionary<string, ScriptField>
	scroll_size: integer
	}
	}

[kosabogi]

In response bodies: The parameter description is missing, and only the generic "Duration" type description is shown:

In which API did you expect frequency with a parameter description? The only one I found is ml.update_datafeed, and there is indeed no description in the spec itself, which suggests this is not a propagation bug but a specification bug.

elasticsearch-specification/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts

Lines 31 to 49 in 98ec7ac

export class Response {
body: {
authorization?: DatafeedAuthorization
aggregations?: Dictionary<string, AggregationContainer>
chunking_config: ChunkingConfig
delayed_data_check_config?: DelayedDataCheckConfig
datafeed_id: Id
frequency?: Duration
indices: string[]
indices_options?: IndicesOptions
job_id: Id
max_empty_searches?: integer
query: QueryContainer
query_delay: Duration
runtime_mappings?: RuntimeFields
script_fields?: Dictionary<string, ScriptField>
scroll_size: integer
}
}

Hey! In the meantime, we dived deeper into this with @l-trotta and found out that we need to add the description in the specifications, as you mentioned. I've just opened a PR to address this but forgot to close this issue. I'm closing it now since it's resolved.