From ffa96e6b0b821f84e6beba68c68376aea08a446d Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 7 Oct 2021 14:33:01 -0700 Subject: [PATCH] [DOCS] Fixes ML get calendars API (#78808) (#78855) --- .../apis/get-calendar.asciidoc | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc index 1cd86e21aff8b..a2b0f0f34b322 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc @@ -39,15 +39,29 @@ For more information, see (Required, string) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +[[ml-get-calendar-query-parms]] +== {api-query-parms-title} + +`from`:: + (Optional, integer) Skips the specified number of calendars. This parameter + is supported only when you omit the ``. Defaults to `0`. + +`size`:: + (Optional, integer) Specifies the maximum number of calendars to obtain. + This parameter is supported only when you omit the ``. Defaults + to `100`. + [[ml-get-calendar-request-body]] == {api-request-body-title} `page`.`from`:: - (Optional, integer) Skips the specified number of calendars. Defaults to `0`. + (Optional, integer) Skips the specified number of calendars. This object is + supported only when you omit the ``. Defaults to `0`. `page`.`size`:: (Optional, integer) Specifies the maximum number of calendars to obtain. - Defaults to `0`. + This object is supported only when you omit the ``. Defaults + to `100`. [[ml-get-calendar-results]] == {api-response-body-title}