diff --git a/output/schema/schema.json b/output/schema/schema.json index 82754bc9d3..a02a7ba70c 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -22616,7 +22616,7 @@ "visibility": "feature_flag" } }, - "description": "Disable logs stream\n\nThis disables the logs stream feature for this cluster.", + "description": "Disable logs stream.\n\nTurn off the logs stream feature for this cluster.", "docId": "streams-logs-disable", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", "name": "streams.logs_disable", @@ -22656,7 +22656,7 @@ "visibility": "feature_flag" } }, - "description": "Enable logs stream\n\nThis enables the logs stream feature for this cluster.\n\nNote: To protect existing data, this feature can only be enabled on a cluster if\nit does not have existing indices or data streams matching the pattern `logs|logs.*`.\nIf this is the case, a `409 - Conflict` response and error will be returned.", + "description": "Enable logs stream.\n\nTurn on the logs stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the\ncluster does not have existing indices or data streams that match the pattern `logs|logs.*`.\nIf those indices or data streams exist, a `409 - Conflict` response and error is returned.", "docId": "streams-logs-enable", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", "name": "streams.logs_enable", @@ -22696,7 +22696,7 @@ "visibility": "feature_flag" } }, - "description": "Get the status of streams\n\nGets the current status of all stream types", + "description": "Get the status of streams.\n\nGet the current status for all types of streams.", "docId": "streams-status", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", "name": "streams.status", @@ -257984,7 +257984,7 @@ "body": { "kind": "no_body" }, - "description": "Disable logs stream\n\nThis disables the logs stream feature for this cluster.", + "description": "Disable logs stream.\n\nTurn off the logs stream feature for this cluster.", "examples": { "PostStreamsDisableRequestExample1": { "method_request": "POST _streams/logs/_disable", @@ -258066,7 +258066,7 @@ "body": { "kind": "no_body" }, - "description": "Enable logs stream\n\nThis enables the logs stream feature for this cluster.\n\nNote: To protect existing data, this feature can only be enabled on a cluster if\nit does not have existing indices or data streams matching the pattern `logs|logs.*`.\nIf this is the case, a `409 - Conflict` response and error will be returned.", + "description": "Enable logs stream.\n\nTurn on the logs stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the\ncluster does not have existing indices or data streams that match the pattern `logs|logs.*`.\nIf those indices or data streams exist, a `409 - Conflict` response and error is returned.", "examples": { "PostStreamsEnableRequestExample1": { "method_request": "POST _streams/logs/_enable", @@ -258148,6 +258148,7 @@ }, "properties": [ { + "description": "If true, the logs stream feature is enabled.", "name": "enabled", "required": true, "type": { @@ -258159,7 +258160,7 @@ } } ], - "specLocation": "streams/status/StreamsStatusResponse.ts#L26-L28" + "specLocation": "streams/status/StreamsStatusResponse.ts#L26-L31" }, { "kind": "request", @@ -258169,7 +258170,7 @@ "body": { "kind": "no_body" }, - "description": "Get the status of streams\n\nGets the current status of all stream types", + "description": "Get the status of streams.\n\nGet the current status for all types of streams.", "examples": { "GetStreamsStatusRequestExample1": { "method_request": "GET _streams/status", diff --git a/specification/streams/logs_disable/StreamsLogsDisableRequest.ts b/specification/streams/logs_disable/StreamsLogsDisableRequest.ts index 85bf71a197..c44e6060cb 100644 --- a/specification/streams/logs_disable/StreamsLogsDisableRequest.ts +++ b/specification/streams/logs_disable/StreamsLogsDisableRequest.ts @@ -21,9 +21,9 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** - * Disable logs stream + * Disable logs stream. * - * This disables the logs stream feature for this cluster. + * Turn off the logs stream feature for this cluster. * @rest_spec_name streams.logs_disable * @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream * @cluster_privileges manage diff --git a/specification/streams/logs_enable/StreamsLogsEnableRequest.ts b/specification/streams/logs_enable/StreamsLogsEnableRequest.ts index 43b5948b88..71915b4446 100644 --- a/specification/streams/logs_enable/StreamsLogsEnableRequest.ts +++ b/specification/streams/logs_enable/StreamsLogsEnableRequest.ts @@ -21,13 +21,13 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** - * Enable logs stream + * Enable logs stream. * - * This enables the logs stream feature for this cluster. + * Turn on the logs stream feature for this cluster. * - * Note: To protect existing data, this feature can only be enabled on a cluster if - * it does not have existing indices or data streams matching the pattern `logs|logs.*`. - * If this is the case, a `409 - Conflict` response and error will be returned. + * NOTE: To protect existing data, this feature can be turned on only if the + * cluster does not have existing indices or data streams that match the pattern `logs|logs.*`. + * If those indices or data streams exist, a `409 - Conflict` response and error is returned. * @rest_spec_name streams.logs_enable * @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream * @cluster_privileges manage diff --git a/specification/streams/status/StreamsStatusRequest.ts b/specification/streams/status/StreamsStatusRequest.ts index db6883d95b..e3877e030c 100644 --- a/specification/streams/status/StreamsStatusRequest.ts +++ b/specification/streams/status/StreamsStatusRequest.ts @@ -21,9 +21,9 @@ import { RequestBase } from '@_types/Base' import { TimeUnit } from '@_types/Time' /** - * Get the status of streams + * Get the status of streams. * - * Gets the current status of all stream types + * Get the current status for all types of streams. * @rest_spec_name streams.status * @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream * @cluster_privileges monitor diff --git a/specification/streams/status/StreamsStatusResponse.ts b/specification/streams/status/StreamsStatusResponse.ts index c5eb318485..ccc7f8d957 100644 --- a/specification/streams/status/StreamsStatusResponse.ts +++ b/specification/streams/status/StreamsStatusResponse.ts @@ -24,5 +24,8 @@ export class Response { } export class LogsStatus { + /** + * If true, the logs stream feature is enabled. + */ enabled: boolean }