Skip to content

Commit eee84d7

Browse files
lcawlgithub-actions[bot]
authored andcommitted
Edit the log streams endpoint docs (#5305)
(cherry picked from commit 7dec8b0)
1 parent f16a25d commit eee84d7

File tree

5 files changed

+20
-16
lines changed

5 files changed

+20
-16
lines changed

output/schema/schema.json

Lines changed: 8 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/streams/logs_disable/StreamsLogsDisableRequest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ import { RequestBase } from '@_types/Base'
2121
import { Duration } from '@_types/Time'
2222

2323
/**
24-
* Disable logs stream
24+
* Disable logs stream.
2525
*
26-
* This disables the logs stream feature for this cluster.
26+
* Turn off the logs stream feature for this cluster.
2727
* @rest_spec_name streams.logs_disable
2828
* @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream
2929
* @cluster_privileges manage

specification/streams/logs_enable/StreamsLogsEnableRequest.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ import { RequestBase } from '@_types/Base'
2121
import { Duration } from '@_types/Time'
2222

2323
/**
24-
* Enable logs stream
24+
* Enable logs stream.
2525
*
26-
* This enables the logs stream feature for this cluster.
26+
* Turn on the logs stream feature for this cluster.
2727
*
28-
* Note: To protect existing data, this feature can only be enabled on a cluster if
29-
* it does not have existing indices or data streams matching the pattern `logs|logs.*`.
30-
* If this is the case, a `409 - Conflict` response and error will be returned.
28+
* NOTE: To protect existing data, this feature can be turned on only if the
29+
* cluster does not have existing indices or data streams that match the pattern `logs|logs.*`.
30+
* If those indices or data streams exist, a `409 - Conflict` response and error is returned.
3131
* @rest_spec_name streams.logs_enable
3232
* @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream
3333
* @cluster_privileges manage

specification/streams/status/StreamsStatusRequest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ import { RequestBase } from '@_types/Base'
2121
import { TimeUnit } from '@_types/Time'
2222

2323
/**
24-
* Get the status of streams
24+
* Get the status of streams.
2525
*
26-
* Gets the current status of all stream types
26+
* Get the current status for all types of streams.
2727
* @rest_spec_name streams.status
2828
* @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream
2929
* @cluster_privileges monitor

specification/streams/status/StreamsStatusResponse.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,8 @@ export class Response {
2424
}
2525

2626
export class LogsStatus {
27+
/**
28+
* If true, the logs stream feature is enabled.
29+
*/
2730
enabled: boolean
2831
}

0 commit comments

Comments
 (0)