From 67a884ec88bd18a7866a82efe7b164b3b48459d2 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 26 Jul 2018 12:28:26 -0700 Subject: [PATCH] [DOCS] Fixes formatting of scope object in job resource --- .../docs/en/rest-api/ml/jobresource.asciidoc | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/x-pack/docs/en/rest-api/ml/jobresource.asciidoc b/x-pack/docs/en/rest-api/ml/jobresource.asciidoc index 3c4e330722f..fb3424cab3f 100644 --- a/x-pack/docs/en/rest-api/ml/jobresource.asciidoc +++ b/x-pack/docs/en/rest-api/ml/jobresource.asciidoc @@ -434,17 +434,20 @@ A rule has the following properties: as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results. + `scope`:: - (object) An optional scope of series where the rule applies. By default the scope - includes all series. Scoping is allowed for any of the partition/by/over fields. - To add a scope for a field add the field name as a key in the scope object and - set its value to an object with properties: - `filter_id`:: - (string) The id of the <> to be used. - `filter_type`:: - (string) Either `include` (the rule applies for values in the filter) - or `exclude` (the rule applies for values not in the filter). Defaults - to `include`. + (object) An optional scope of series where the rule applies. By default, the + scope includes all series. Scoping is allowed for any of the fields that are + also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. + To add a scope for a field, add the field name as a key in the scope object and + set its value to an object with the following properties: +`filter_id`::: + (string) The id of the <> to be used. + +`filter_type`::: + (string) Either `include` (the rule applies for values in the filter) + or `exclude` (the rule applies for values not in the filter). Defaults + to `include`. `conditions`:: (array) An optional array of numeric conditions when the rule applies.