mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-15 01:16:09 +00:00
f1c7ed647b
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.
217 lines
4.7 KiB
Plaintext
217 lines
4.7 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[get-enrich-policy-api]]
|
|
=== Get enrich policy API
|
|
++++
|
|
<titleabbrev>Get enrich policy</titleabbrev>
|
|
++++
|
|
|
|
Returns information about an enrich policy.
|
|
|
|
////
|
|
[source,console]
|
|
----
|
|
PUT /users
|
|
|
|
PUT /_enrich/policy/my-policy
|
|
{
|
|
"match": {
|
|
"indices": "users",
|
|
"match_field": "email",
|
|
"enrich_fields": ["first_name", "last_name", "city", "zip", "state"]
|
|
}
|
|
}
|
|
|
|
PUT /_enrich/policy/other-policy
|
|
{
|
|
"match": {
|
|
"indices": "users",
|
|
"match_field": "email",
|
|
"enrich_fields": ["first_name", "last_name", "city", "zip", "state"]
|
|
}
|
|
}
|
|
----
|
|
////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_enrich/policy/my-policy
|
|
--------------------------------------------------
|
|
// TEST[continued]
|
|
|
|
|
|
[[get-enrich-policy-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_enrich/policy/<enrich-policy>`
|
|
|
|
`GET /_enrich/policy`
|
|
|
|
`GET /_enrich/policy1,policy2`
|
|
|
|
|
|
[[get-enrich-policy-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
include::put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs]
|
|
|
|
|
|
[[get-enrich-policy-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<enrich-policy>`::
|
|
+
|
|
--
|
|
(Optional, string)
|
|
Comma-separated list of enrich policy names
|
|
used to limit the request.
|
|
|
|
To return information for all enrich policies,
|
|
omit this parameter.
|
|
--
|
|
|
|
|
|
[[get-enrich-policy-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
|
|
[[get-enrich-policy-api-single-ex]]
|
|
===== Get a single policy
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_enrich/policy/my-policy
|
|
--------------------------------------------------
|
|
// TEST[continued]
|
|
|
|
The API returns the following response:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"policies": [
|
|
{
|
|
"match": {
|
|
"name" : "my-policy",
|
|
"indices" : ["users"],
|
|
"match_field" : "email",
|
|
"enrich_fields" : [
|
|
"first_name",
|
|
"last_name",
|
|
"city",
|
|
"zip",
|
|
"state"
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
|
|
|
|
[[get-enrich-policy-api-commas-ex]]
|
|
===== Get multiple policies
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_enrich/policy/my-policy,other-policy
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[continued]
|
|
|
|
The API returns the following response:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"policies": [
|
|
{
|
|
"match": {
|
|
"name" : "my-policy",
|
|
"indices" : ["users"],
|
|
"match_field" : "email",
|
|
"enrich_fields" : [
|
|
"first_name",
|
|
"last_name",
|
|
"city",
|
|
"zip",
|
|
"state"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"match": {
|
|
"name" : "other-policy",
|
|
"indices" : ["users"],
|
|
"match_field" : "email",
|
|
"enrich_fields" : [
|
|
"first_name",
|
|
"last_name",
|
|
"city",
|
|
"zip",
|
|
"state"
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE
|
|
|
|
|
|
[[get-enrich-policy-api-all-ex]]
|
|
===== Get all policies
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_enrich/policy
|
|
--------------------------------------------------
|
|
// TEST[continued]
|
|
|
|
The API returns the following response:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"policies": [
|
|
{
|
|
"match": {
|
|
"name" : "my-policy",
|
|
"indices" : ["users"],
|
|
"match_field" : "email",
|
|
"enrich_fields" : [
|
|
"first_name",
|
|
"last_name",
|
|
"city",
|
|
"zip",
|
|
"state"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"match": {
|
|
"name" : "other-policy",
|
|
"indices" : ["users"],
|
|
"match_field" : "email",
|
|
"enrich_fields" : [
|
|
"first_name",
|
|
"last_name",
|
|
"city",
|
|
"zip",
|
|
"state"
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
|
|
////
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE /_enrich/policy/my-policy
|
|
DELETE /_enrich/policy/other-policy
|
|
--------------------------------------------------
|
|
// TEST[continued]
|
|
////
|