Skip to content

Commit 877c544

Browse files
committed
[DOCS] Fixes formatting of scope object in job resource
1 parent 3e217dc commit 877c544

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

x-pack/docs/en/rest-api/ml/jobresource.asciidoc

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -434,17 +434,20 @@ A rule has the following properties:
434434
as usual. This action is suitable when certain values are expected to be
435435
consistently anomalous and they affect the model in a way that negatively
436436
impacts the rest of the results.
437+
437438
`scope`::
438-
(object) An optional scope of series where the rule applies. By default the scope
439-
includes all series. Scoping is allowed for any of the partition/by/over fields.
440-
To add a scope for a field add the field name as a key in the scope object and
441-
set its value to an object with properties:
442-
`filter_id`::
443-
(string) The id of the <<ml-filter-resource,filter>> to be used.
444-
`filter_type`::
445-
(string) Either `include` (the rule applies for values in the filter)
446-
or `exclude` (the rule applies for values not in the filter). Defaults
447-
to `include`.
439+
(object) An optional scope of series where the rule applies. By default, the
440+
scope includes all series. Scoping is allowed for any of the fields that are
441+
also specified in `by_field_name`, `over_field_name`, or `partition_field_name`.
442+
To add a scope for a field, add the field name as a key in the scope object and
443+
set its value to an object with the following properties:
444+
`filter_id`:::
445+
(string) The id of the <<ml-filter-resource,filter>> to be used.
446+
447+
`filter_type`:::
448+
(string) Either `include` (the rule applies for values in the filter)
449+
or `exclude` (the rule applies for values not in the filter). Defaults
450+
to `include`.
448451

449452
`conditions`::
450453
(array) An optional array of numeric conditions when the rule applies.

0 commit comments

Comments
 (0)