Skip to content

Commit

Permalink
[DOCS] Fixes query parameters for get buckets API (#80643)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Nov 22, 2021
1 parent cf30b54 commit 38cbd11
Show file tree
Hide file tree
Showing 7 changed files with 106 additions and 40 deletions.
46 changes: 35 additions & 11 deletions docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,17 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
(Optional, string) The timestamp of a single bucket result. If you do not
specify this parameter, the API returns information about all buckets.

[[ml-get-bucket-request-body]]
== {api-request-body-title}

[[ml-get-bucket-query-parms]]
== {api-query-parms-title}

`anomaly_score`::
(Optional, double) Returns buckets with anomaly scores greater or equal than
this value. Defaults to `0.0`.

`desc`::
(Optional, Boolean) If true, the buckets are sorted in descending order. Defaults to `false`.
(Optional, Boolean) If true, the buckets are sorted in descending order.
Defaults to `false`.

`end`::
(Optional, string) Returns buckets with timestamps earlier than this time.
Expand All @@ -60,11 +62,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
`expand`::
(Optional, Boolean) If true, the output includes anomaly records. Defaults to `false`.

`page`.`from`::
`from`::
(Optional, integer) Skips the specified number of buckets. Defaults to `0`.

`page`.`size`::
(Optional, integer) Specifies the maximum number of buckets to obtain. Defaults to `100`.
`size`::
(Optional, integer) Specifies the maximum number of buckets to obtain. Defaults
to `100`.

`sort`::
(Optional, string) Specifies the sort field for the requested buckets. By
Expand All @@ -75,6 +78,26 @@ default, the buckets are sorted by the `timestamp` field.
`-1`, which means it is unset and results are not limited to specific
timestamps.

[[ml-get-bucket-request-body]]
== {api-request-body-title}

You can also specify the query parameters in the request body; the exception are
`from` and `size`, use `page` instead:

`page`::
+
.Properties of `page`
[%collapsible%open]
====
`from`:::
(Optional, integer) Skips the specified number of buckets. Defaults to `0`.
`size`:::
(Optional, integer) Specifies the maximum number of buckets to obtain. Defaults
to `100`.
====

[role="child_attributes"]
[[ml-get-bucket-results]]
== {api-response-body-title}
Expand All @@ -101,15 +124,16 @@ influencer. This score might be updated as newer data is analyzed.
(number) The length of the bucket in seconds. This value matches the
`bucket_span` that is specified in the job.
`initial_anomaly_score`:::
(number) The score between 0-100 for each bucket influencer. This score is the
initial value that was calculated at the time the bucket was processed.
`influencer_field_name`:::
(string) The field name of the influencer.
////
`influencer_field_value`:::
(string) The field value of the influencer.
////
`initial_anomaly_score`:::
(number) The score between 0-100 for each bucket influencer. This score is the
initial value that was calculated at the time the bucket was processed.
`is_interim`:::
(Boolean)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,23 @@ as the calendar identifier.
[[ml-get-calendar-event-request-body]]
== {api-request-body-title}

You can also specify some of the query parameters (such as `end` and
`job_id`) in the request body.
You can also specify the query parameters in the request body; the exception are
`from` and `size`, use `page` instead:

`page.from`::
(Optional, integer) Skips the specified number of events. Defaults to `0`.
`page`::
+
.Properties of `page`
[%collapsible%open]
====
`from`:::
(Optional, integer) Skips the specified number of events. Defaults to `0`.
`size`:::
(Optional, integer) Specifies the maximum number of events to obtain. Defaults
to `100`.
====

`page.size`::
(Optional, integer) Specifies the maximum number of events to obtain.
Defaults to `100`.

[[ml-get-calendar-event-results]]
== {api-response-body-title}
Expand Down
22 changes: 14 additions & 8 deletions docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,20 @@ or by omitting the identifier.
[[ml-get-calendar-request-body]]
== {api-request-body-title}

`page`.`from`::
(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.
This object is supported only when you omit the `<calendar_id>`. Defaults
to `100`.
`page`::
+
.Properties of `page`
[%collapsible%open]
====
`from`:::
(Optional, integer) Skips the specified number of calendars. This object is
supported only when you omit the `<calendar_id>`. Defaults to `0`.
`size`:::
(Optional, integer) Specifies the maximum number of calendars to obtain. This
object is supported only when you omit the `<calendar_id>`. Defaults to `100`.
====

[[ml-get-calendar-results]]
== {api-response-body-title}
Expand Down
11 changes: 9 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/get-category.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,19 @@ Defaults to `100`.
You can also specify the `partition_field_value` query parameter in the
request body.

`page`.`from`::
`page`::
+
.Properties of `page`
[%collapsible%open]
====
`from`:::
(Optional, integer) Skips the specified number of categories. Defaults to `0`.
`page`.`size`::
`size`:::
(Optional, integer) Specifies the maximum number of categories to obtain.
Defaults to `100`.
====

[[ml-get-category-results]]
== {api-response-body-title}
Expand Down
15 changes: 11 additions & 4 deletions docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,22 @@ timestamps.
[[ml-get-influencer-request-body]]
== {api-request-body-title}

You can also specify some of the query parameters (such as `desc` and
`end`) in the request body.
You can also specify the query parameters in the request body; the exception are
`from` and `size`, use `page` instead:

`page`.`from`::
`page`::
+
.Properties of `page`
[%collapsible%open]
====
`from`:::
(Optional, integer) Skips the specified number of influencers. Defaults to `0`.
`page`.`size`::
`size`:::
(Optional, integer) Specifies the maximum number of influencers to obtain.
Defaults to `100`.
====

[[ml-get-influencer-results]]
== {api-response-body-title}
Expand Down
15 changes: 11 additions & 4 deletions docs/reference/ml/anomaly-detection/apis/get-record.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,22 @@ default, the records are sorted by the `record_score` value.
[[ml-get-record-request-body]]
== {api-request-body-title}

You can also specify some of the query parameters (such as `desc` and
`end`) in the request body.
You can also specify the query parameters in the request body; the exception are
`from` and `size`, use `page` instead:

`page`.`from`::
`page`::
+
.Properties of `page`
[%collapsible%open]
====
`from`:::
(Optional, integer) Skips the specified number of records. Defaults to `0`.
`page`.`size`::
`size`:::
(Optional, integer) Specifies the maximum number of records to obtain. Defaults
to `100`.
====

[[ml-get-record-results]]
== {api-response-body-title}
Expand Down
15 changes: 11 additions & 4 deletions docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,22 @@ specifying `*` as the snapshot ID, or by omitting the snapshot ID.
[[ml-get-snapshot-request-body]]
== {api-request-body-title}

You can also specify some of the query parameters (such as `desc` and
`end`) in the request body.
You can also specify the query parameters in the request body; the exception are
`from` and `size`, use `page` instead:

`page`.`from`::
`page`::
+
.Properties of `page`
[%collapsible%open]
====
`from`:::
(Optional, integer) Skips the specified number of snapshots. Defaults to `0`.
`page`.`size`::
`size`:::
(Optional, integer) Specifies the maximum number of snapshots to obtain.
Defaults to `100`.
====

[role="child_attributes"]
[[ml-get-snapshot-results]]
Expand Down

0 comments on commit 38cbd11

Please sign in to comment.