Add bytes into "Query parameters" for CAT Segment Replication API (o…

…pensearch-project#4731) * Add `byte` into "Query parameters" for CAT Segment Replication API Signed-off-by: Tianli Feng <[email protected]> * Add a trailing slash to the links Signed-off-by: Tianli Feng <[email protected]> * Correct the parameter name to bytes Signed-off-by: Tianli Feng <[email protected]> * Change data type of 'bytes' and 'time' parameters to 'Byte unites' and 'Time unites' Signed-off-by: Tianli Feng <[email protected]> --------- Signed-off-by: Tianli Feng <[email protected]>
tlfeng · Aug 10, 2023 · 4d6106a · 4d6106a
1 parent 1a1a385
commit 4d6106a
Showing 1 changed file with 12 additions and 11 deletions.
diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md
@@ -34,17 +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.
-`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).
-`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