Commit Graph

11 Commits

Author SHA1 Message Date
James Rodewig f56a0f4b66
[DOCS] Remove `testenv` annotations from doc snippet tests (#80023)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
2021-11-05 18:38:50 -04:00
James Rodewig 80b674fb25
[DOCS] Reformat snippets to use two-space indents (#59973) 2020-07-21 12:24:26 -04:00
Thiago Souza 863a883286 [DOCS] Correct get enrich policy API request example (#56207) 2020-05-05 12:34:50 -04:00
Russ Cam 94f6f946ef
Specify name on enrich.get_policy as list type (#50217)
This commit updates the enrich.get_policy API to specify name
as a list, in line with other URL parts that accept a comma-separated
list of values. 

In addition, update the get enrich policy API docs
to align the URL part name in the documentation with
the name used in the REST API specs.
2020-02-20 12:33:06 +11:00
James Rodewig c9e9685bfd
[DOCS] Add high-level docs for enrich processor and policies (#49194)
* [DOCS] Add high-level docs for enrich policies

* fix typos

* fix typo

* add warning for enrich policy changes

* add addtl cross-links to execute API docs

* Reword match and geo_match policy example headings
2019-11-19 13:56:51 -05:00
Martijn van Groningen 1ef8dc4030
Also validate source index at put enrich policy time. (#48254)
This changes tests to create a valid
source index prior to creating the enrich policy.
2019-10-21 19:34:57 +02:00
Martijn van Groningen a23c7af811
Add config namespace in get policy api response (#47162)
Currently the policy config is placed directly in the json object
of the toplevel `policies` array field. For example:

```
{
    "policies": [
        {
            "match": {
                "name" : "my-policy",
                "indices" : ["users"],
                "match_field" : "email",
                "enrich_fields" : [
                    "first_name",
                    "last_name",
                    "city",
                    "zip",
                    "state"
                ]
            }
        }
    ]
}
```

This change adds a `config` field in each policy json object:

```
{
    "policies": [
        {
            "config": {
                "match": {
                    "name" : "my-policy",
                    "indices" : ["users"],
                    "match_field" : "email",
                    "enrich_fields" : [
                        "first_name",
                        "last_name",
                        "city",
                        "zip",
                        "state"
                    ]
                }
            }
        }
    ]
}
```

This allows us in the future to add other information about policies
in the get policy api response.

The UI will consume this API to build an overview of all policies.
The UI may in the future include additional information about a policy
and the plan is to include that in the get policy api, so that this
information can be gathered in a single api call.

An example of the information that is likely to be added is:
* Last policy execution time
* The status of a policy (executing, executed, unexecuted)
* Information about the last failure if exists
2019-09-30 14:36:53 +02:00
James Rodewig a18b587f59
[DOCS] Correct `<enrich-policy>` parm description for comma-sep list (#46682) 2019-09-18 08:30:22 -04:00
James Rodewig 2fbaf32412
[DOCS] Change // CONSOLE comments to [source,console] (#46669) 2019-09-12 10:13:21 -04:00
Michael Basnight 53b19af59b
Allow comma separated ids in get enrich policy API (#46351)
This commit changes the GET REST api so it will accept an optional comma
separated list of enrich policy ids. This change also modifies the
behavior of the GET API in that it will not error if it is passed a bad
enrich id anymore, but will instead just return an empty list.
2019-09-10 10:42:28 -05:00
James Rodewig dace374e26
[DOCS] Separate Enrich API Docs (#46286)
* Add enrich policy common parameter

* Add enrich APIs to REST APIs index

* Add put enrich policy API docs

* Add get enrich policy API docs

* Add delete enrich policy API docs

* Add execute enrich policy API docs
2019-09-04 14:11:52 -04:00