Skip to content

Commit

Permalink
[DOCS] Fixes ML get calendars API (#78808) (#78854)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Oct 7, 2021
1 parent c874da4 commit 6695c7c
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<calendar_id>`. Defaults to `0`.

`size`::
(Optional, integer) Specifies the maximum number of calendars to obtain.
This parameter is supported only when you omit the `<calendar_id>`. 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 `<calendar_id>`. 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 `<calendar_id>`. Defaults
to `100`.

[[ml-get-calendar-results]]
== {api-response-body-title}
Expand Down

0 comments on commit 6695c7c

Please sign in to comment.