honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference
History
Martijn van Groningen fe937ea4b8
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:37:23 +02:00
..
aggregations [DOCS] Fix calendar interval typos for date histo agg (#46911) 2019-09-20 15:22:41 -04:00
analysis Fixed sample code for minhash (#46385) 2019-09-12 13:29:44 -04:00
cat [DOCS] Document missing query parms for cat recovery API (#47181) (#47235) 2019-09-27 16:31:10 -04:00
ccr [DOCS] Add 'remote clusters' requirement link to CCR docs (#47185) 2019-09-26 16:15:21 -04:00
cluster [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
commands [DOCS] Adds command reference for elasticsearch-croneval (#43946) 2019-07-25 11:41:05 -07:00
docs [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
graph [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
high-availability [DOCS] Add CCR docs to the Elasticsearch Reference Guide (#45704) 2019-09-17 14:26:20 -04:00
how-to [DOCS] Correct link to `index.store.preload` setting (#47145) 2019-09-26 08:57:09 -04:00
ilm Add support for POST requests to SLM Execute API (#47061) 2019-09-25 16:15:10 -06:00
images DOC: Update section for SQuirrel SQL 4.0.0 (#46726) 2019-09-16 12:27:31 +03:00
index-modules [DOCS] Correct link to `index.store.preload` setting (#47145) 2019-09-26 08:57:09 -04:00
indices [DOCS] Reformat clone index API docs (#46762) 2019-09-25 12:37:53 -04:00
ingest Add config namespace in get policy api response (#47162) 2019-09-30 14:37:23 +02:00
licensing [DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] (#46449) (#46459) 2019-09-06 16:09:09 -04:00
mapping Mention ip fields in the global ordinals docs. (#47045) 2019-09-24 12:39:11 -07:00
migration [DOCS] Add 7.4 breaking changes for transforms and data frame analytics (#46821) 2019-09-24 17:20:25 +01:00
ml [DOCS] Adds regression analytics resources and examples to the data frame analytics APIs and the evaluation API (#46176) 2019-09-19 09:23:18 +02:00
modules Remove docs for proxy mode (#46677) 2019-09-13 22:20:11 +01:00
monitoring [DOCS] Skip code snippet testing in monitoring example 2019-09-27 17:11:24 -07:00
query-dsl [DOCS] Add multi-level nested query example to nested query docs (#46986) 2019-09-25 02:01:37 -04:00
release-notes Updates 7.4.0 release notes 2019-09-27 09:20:08 +01:00
rest-api Merge remote-tracking branch 'es/7.x' into enrich-7.x 2019-09-30 08:12:28 +02:00
rollup [DOCS] Group rollup and transform content (#46882) 2019-09-23 08:55:25 -07:00
scripting [DOCS] Change // CONSOLE comments to [source,console] (#46440) (#46494) 2019-09-09 12:35:50 -04:00
search [DOCS] Reformats Profile API (#47168) 2019-09-27 11:14:14 +02:00
security [DOCS] Add security section to Elasticsearch book (#46883) 2019-09-20 11:34:37 -07:00
settings [DOCS] Adds production monitoring page (#47184) 2019-09-27 15:01:54 -07:00
setup [DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] (#46449) (#46459) 2019-09-06 16:09:09 -04:00
sql SQL: Add alias DATETRUNC to DATE_TRUNC function (#47173) 2019-09-27 15:38:51 +03:00
testing Uppercasing some docs section title (#37781) 2019-01-24 22:54:55 +01:00
transform [DOCS] Fix links to transform pages (#47134) 2019-09-25 13:09:47 -07:00
upgrade [DOCS] Replace "// CONSOLE" comments with [source,console] (#46159) (#46332) 2019-09-05 10:11:25 -04:00
vectors [DOCS] Replace "// CONSOLE" comments with [source,console] (#46159) (#46332) 2019-09-05 10:11:25 -04:00
aggregations.asciidoc [Docs] Update aggregations.asciidoc (#29265) 2018-03-28 15:01:45 +02:00
analysis.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
api-conventions.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
cat.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
cluster.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
data-rollup-transform.asciidoc [DOCS] Adds transforms to Elasticsearch book (#46846) (#47055) 2019-09-25 08:11:37 -07:00
docs.asciidoc [DOCS] Remove heading offsets for REST APIs (#44568) 2019-07-19 14:36:06 -04:00
frozen-indices.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
getting-started.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
glossary.asciidoc [DOCS] Update tagged region for index alias desc (#46886) 2019-09-19 15:30:33 -04:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
high-availability.asciidoc [DOCS] Remove leveloffset for CCR docs (#46818) 2019-09-18 09:44:43 -04:00
how-to.asciidoc Correct grammar in list in how-to docs 2017-01-17 20:57:22 -05:00
index-modules.asciidoc Add the ability to require an ingest pipeline (#46847) 2019-09-19 16:37:45 -04:00
index.asciidoc [DOCS] Merge monitoring sections in Elasticsearch book (#46885) 2019-09-24 11:39:28 -07:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc [DOCS] Separate and reformat synced flush API docs (#46634) (#46839) 2019-09-19 08:22:37 -04:00
ingest.asciidoc [DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] (#46449) (#46459) 2019-09-06 16:09:09 -04:00
intro.asciidoc [DOCS] Edited title/subtitle. (#43552) 2019-06-24 15:31:19 -07:00
mapping.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46441) (#46451) 2019-09-06 11:31:13 -04:00
modules.asciidoc Retitle and relocate cross-cluster search docs (#45608) 2019-08-15 16:28:04 -04:00
query-dsl.asciidoc [SPATIAL] Backport new ShapeFieldMapper and ShapeQueryBuilder to 7x (#45363) 2019-08-14 16:35:10 -05:00
redirects.asciidoc [DOCS] Add redirect for SLM API docs (#46838) (#46865) 2019-09-27 11:05:55 -04:00
release-notes.asciidoc [DOCS] Adds machine learning PRs to release notes (#46564) 2019-09-11 08:30:59 -07:00
scripting.asciidoc [DOCS] Move 'Scripting' section to top-level navigation. (#42939) 2019-06-06 10:46:02 -04:00
search.asciidoc Use snake casing for document field (#45432) 2019-09-19 14:27:00 +02:00
setup.asciidoc [ML][Data Frame] adding dynamic cluster setting for failure retries (#44577) (#44639) 2019-07-19 16:17:39 -05:00
testing.asciidoc [Docs] Unify spelling of Elasticsearch (#27567) 2017-11-29 09:44:25 +01:00
upgrade.asciidoc [DOCS] Fix upgrade paths for 7.5 (#46150) 2019-09-04 13:42:24 -04:00