From 815116cf499c5cb61eb81933a144765cc0292072 Mon Sep 17 00:00:00 2001 From: Tianli Feng Date: Wed, 9 Aug 2023 15:07:59 -0700 Subject: [PATCH 1/4] Add `byte` into "Query parameters" for CAT Segment Replication API Signed-off-by: Tianli Feng --- _api-reference/cat/cat-segment-replication.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 9a84b861eb..fe1a6a567b 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -39,10 +39,11 @@ Parameter | Data type | Description `active_only` | Boolean | If `true`, the response only includes active segment replications. Defaults to `false`. [`detailed`](#additional-detailed-response-metrics) | String | If `true`, the response includes additional metrics for each stage of a segment replication event. Defaults to `false`. `shards` | String | A comma-separated list of shards to display. +`byte` | Byte size | [Units]({{site.url}}{{site.baseurl}}/opensearch/units) used to display byte size values. `format` | String | A short version of the HTTP accept header. Valid values include `JSON` and `YAML`. `h` | String | A comma-separated list of column names to display. `help` | Boolean | If `true`, the response includes help information. Defaults to `false`. -`time` | Time value | [Units]({{site.url}}{{site.baseurl}}/opensearch/units) used to display time values. Defaults to `ms` (milliseconds). +`time` | Time | [Units]({{site.url}}{{site.baseurl}}/opensearch/units) used to display time values. `v` | Boolean | If `true`, the response includes column headings. Defaults to `false`. `s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order. From a8486c0e4b001da26d1a2458a62b01f564311299 Mon Sep 17 00:00:00 2001 From: Tianli Feng Date: Wed, 9 Aug 2023 15:32:56 -0700 Subject: [PATCH 2/4] Add a trailing slash to the links Signed-off-by: Tianli Feng --- _api-reference/cat/cat-segment-replication.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index fe1a6a567b..7f0503cdfa 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -39,11 +39,11 @@ Parameter | Data type | Description `active_only` | Boolean | If `true`, the response only includes active segment replications. Defaults to `false`. [`detailed`](#additional-detailed-response-metrics) | String | If `true`, the response includes additional metrics for each stage of a segment replication event. Defaults to `false`. `shards` | String | A comma-separated list of shards to display. -`byte` | Byte size | [Units]({{site.url}}{{site.baseurl}}/opensearch/units) used to display byte size values. +`byte` | Byte size | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display byte size values. `format` | String | A short version of the HTTP accept header. Valid values include `JSON` and `YAML`. `h` | String | A comma-separated list of column names to display. `help` | Boolean | If `true`, the response includes help information. Defaults to `false`. -`time` | Time | [Units]({{site.url}}{{site.baseurl}}/opensearch/units) used to display time values. +`time` | Time | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display time values. `v` | Boolean | If `true`, the response includes column headings. Defaults to `false`. `s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order. From e562be3993a0c52c03e83dbb0817a96fa4e42e70 Mon Sep 17 00:00:00 2001 From: Tianli Feng Date: Wed, 9 Aug 2023 18:11:57 -0700 Subject: [PATCH 3/4] Correct the parameter name to bytes Signed-off-by: Tianli Feng --- _api-reference/cat/cat-segment-replication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 7f0503cdfa..a016930768 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -39,7 +39,7 @@ Parameter | Data type | Description `active_only` | Boolean | If `true`, the response only includes active segment replications. Defaults to `false`. [`detailed`](#additional-detailed-response-metrics) | String | If `true`, the response includes additional metrics for each stage of a segment replication event. Defaults to `false`. `shards` | String | A comma-separated list of shards to display. -`byte` | Byte size | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display byte size values. +`bytes` | Byte size | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display byte size values. `format` | String | A short version of the HTTP accept header. Valid values include `JSON` and `YAML`. `h` | String | A comma-separated list of column names to display. `help` | Boolean | If `true`, the response includes help information. Defaults to `false`. From 89f57afc42287646212a2a4a289a4ef2e249edaf Mon Sep 17 00:00:00 2001 From: Tianli Feng Date: Thu, 10 Aug 2023 00:06:02 -0700 Subject: [PATCH 4/4] Change data type of 'bytes' and 'time' parameters to 'Byte unites' and 'Time unites' Signed-off-by: Tianli Feng --- _api-reference/cat/cat-segment-replication.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index a016930768..2b5b5d2e0d 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -34,18 +34,18 @@ Parameter | Type | Description The CAT segment replication API operation supports the following optional query parameters. -Parameter | Data type | Description -:--- |:---| :--- -`active_only` | Boolean | If `true`, the response only includes active segment replications. Defaults to `false`. -[`detailed`](#additional-detailed-response-metrics) | String | If `true`, the response includes additional metrics for each stage of a segment replication event. Defaults to `false`. -`shards` | String | A comma-separated list of shards to display. -`bytes` | Byte size | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display byte size values. -`format` | String | A short version of the HTTP accept header. Valid values include `JSON` and `YAML`. -`h` | String | A comma-separated list of column names to display. -`help` | Boolean | If `true`, the response includes help information. Defaults to `false`. -`time` | Time | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display time values. -`v` | Boolean | If `true`, the response includes column headings. Defaults to `false`. -`s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order. +Parameter | Data type | Description +:--- |:-----------| :--- +`active_only` | Boolean | If `true`, the response only includes active segment replications. Defaults to `false`. +[`detailed`](#additional-detailed-response-metrics) | String | If `true`, the response includes additional metrics for each stage of a segment replication event. Defaults to `false`. +`shards` | String | A comma-separated list of shards to display. +`bytes` | Byte units | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display byte size values. +`format` | String | A short version of the HTTP accept header. Valid values include `JSON` and `YAML`. +`h` | String | A comma-separated list of column names to display. +`help` | Boolean | If `true`, the response includes help information. Defaults to `false`. +`time` | Time units | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display time values. +`v` | Boolean | If `true`, the response includes column headings. Defaults to `false`. +`s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order. ## Examples