diff --git a/docs/java-rest/high-level/ccr/put_follow.asciidoc b/docs/java-rest/high-level/ccr/put_follow.asciidoc index 68b0d4fbddca..0ea7e596ea65 100644 --- a/docs/java-rest/high-level/ccr/put_follow.asciidoc +++ b/docs/java-rest/high-level/ccr/put_follow.asciidoc @@ -5,13 +5,13 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put Follow API +=== Create follower API [id="{upid}-{api}-request"] ==== Request -The Put Follow API allows creates a follower index and make that index follow a leader index. +Creates a follower index and makes that index follow a leader index. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -19,15 +19,14 @@ include-tagged::{doc-tests-file}[{api}-request] -------------------------------------------------- <1> The name of the remote cluster alias. <2> The name of the leader in the remote cluster. -<3> The name of the follower index that gets created as part of the put follow API call. -<4> The number of active shard copies to wait for before the put follow API returns a -response, as an `ActiveShardCount` +<3> The name of the follower index to create. +<4> The number of shard copies that must be active before the call returns. <5> The settings overrides for the follower index. [id="{upid}-{api}-response"] ==== Response -The returned +{response}+ indicates if the put follow request was received. +The +{response}+ indicates if the request was received. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -38,5 +37,3 @@ include-tagged::{doc-tests-file}[{api}-response] <3> Whether the follower index started following the leader index. include::../execution.asciidoc[] - - diff --git a/docs/java-rest/high-level/cluster/put_component_template.asciidoc b/docs/java-rest/high-level/cluster/put_component_template.asciidoc index 10858f3b4fa8..2ef158ca3daf 100644 --- a/docs/java-rest/high-level/cluster/put_component_template.asciidoc +++ b/docs/java-rest/high-level/cluster/put_component_template.asciidoc @@ -5,12 +5,12 @@ -- [id="{upid}-{api}"] -=== Put Component Template API +=== Create or update component template API -The Put Component Template API allows to create or change a component template. +Creates or updates a component template. [id="{upid}-{api}-request"] -==== Put Component Template Request +==== Request A +{request}+ specifies the name of the component template and the template definition, which can consist of the settings, mappings or aliases, together with a version (which @@ -52,7 +52,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout] include::../execution.asciidoc[] [id="{upid}-{api}-response"] -==== Put Component Templates Response +==== Response The returned +{response}+ allows to retrieve information about the executed operation as follows: diff --git a/docs/java-rest/high-level/enrich/put_policy.asciidoc b/docs/java-rest/high-level/enrich/put_policy.asciidoc index b8e9475bed19..b37adec67257 100644 --- a/docs/java-rest/high-level/enrich/put_policy.asciidoc +++ b/docs/java-rest/high-level/enrich/put_policy.asciidoc @@ -5,12 +5,12 @@ -- [id="{upid}-{api}"] -=== Put Policy API +=== Create or update enrich policy API [id="{upid}-{api}-request"] ==== Request -The Put Policy API stores an enrich policy in Elasticsearch. +Creates or updates an enrich policy. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -20,12 +20,12 @@ include-tagged::{doc-tests-file}[{api}-request] [id="{upid}-{api}-response"] ==== Response -The returned +{response}+ indicates if the put policy request was acknowledged. +The +{response}+ indicates if the request was acknowledged. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- include-tagged::{doc-tests-file}[{api}-response] -------------------------------------------------- -<1> Whether put policy request was acknowledged. +<1> Whether the request was acknowledged. include::../execution.asciidoc[] diff --git a/docs/java-rest/high-level/ilm/put_lifecycle_policy.asciidoc b/docs/java-rest/high-level/ilm/put_lifecycle_policy.asciidoc index 7947f54ffbc7..7cb6f37989a1 100644 --- a/docs/java-rest/high-level/ilm/put_lifecycle_policy.asciidoc +++ b/docs/java-rest/high-level/ilm/put_lifecycle_policy.asciidoc @@ -5,14 +5,13 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put Lifecycle Policy API +=== Create or update lifecycle policy API [id="{upid}-{api}-request"] ==== Request -The Put Lifecycle Policy API allows you to add an Index Lifecycle Management -Policy to the cluster. +Creates or updates an index lifecycle management policy. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -25,14 +24,13 @@ include-tagged::{doc-tests-file}[{api}-request] [id="{upid}-{api}-response"] ==== Response -The returned +{response}+ indicates if the put lifecycle policy request was received. +The +{response}+ indicates if the request was received. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- include-tagged::{doc-tests-file}[{api}-response] -------------------------------------------------- -<1> Whether or not the put lifecycle policy was acknowledged. +<1> Whether or not the request was acknowledged. include::../execution.asciidoc[] - diff --git a/docs/java-rest/high-level/ilm/put_snapshot_lifecycle_policy.asciidoc b/docs/java-rest/high-level/ilm/put_snapshot_lifecycle_policy.asciidoc index 13a0bb6e7828..d9de7d75934c 100644 --- a/docs/java-rest/high-level/ilm/put_snapshot_lifecycle_policy.asciidoc +++ b/docs/java-rest/high-level/ilm/put_snapshot_lifecycle_policy.asciidoc @@ -5,14 +5,13 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put Snapshot Lifecycle Policy API +=== Create or update snapshot lifecycle policy API [id="{upid}-{api}-request"] ==== Request -The Put Snapshot Lifecycle Policy API allows you to add of update the definition of a Snapshot -Lifecycle Management Policy in the cluster. +Creates or updates a snapshot lifecycle management policy. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -22,14 +21,13 @@ include-tagged::{doc-tests-file}[{api}-request] [id="{upid}-{api}-response"] ==== Response -The returned +{response}+ indicates if the put snapshot lifecycle policy request was received. +The +{response}+ indicates if the request was received. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- include-tagged::{doc-tests-file}[{api}-response] -------------------------------------------------- -<1> Whether or not the put snapshot lifecycle policy was acknowledged. +<1> Whether or not the request was acknowledged. include::../execution.asciidoc[] - diff --git a/docs/java-rest/high-level/indices/put_index_template.asciidoc b/docs/java-rest/high-level/indices/put_index_template.asciidoc index 9a1748da0fea..8679c35ccfa3 100644 --- a/docs/java-rest/high-level/indices/put_index_template.asciidoc +++ b/docs/java-rest/high-level/indices/put_index_template.asciidoc @@ -5,10 +5,10 @@ -- [id="{upid}-{api}"] -=== Put Composable Index Template API +=== Create or update composable index template API [id="{upid}-{api}-request"] -==== Put Composable Index Template Request +==== Request A +{request}+ specifies the `name` of a template and the index template configuration which consists of the `patterns` that control whether the template should be applied @@ -108,7 +108,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout] include::../execution.asciidoc[] [id="{upid}-{api}-response"] -==== Put Composable Index Template Response +==== Response The returned +{response}+ allows to retrieve information about the executed operation as follows: diff --git a/docs/java-rest/high-level/indices/put_mapping.asciidoc b/docs/java-rest/high-level/indices/put_mapping.asciidoc index 971ad52d62b7..1e846a3fb05e 100644 --- a/docs/java-rest/high-level/indices/put_mapping.asciidoc +++ b/docs/java-rest/high-level/indices/put_mapping.asciidoc @@ -5,10 +5,13 @@ -- [id="{upid}-{api}"] -=== Put Mapping API +=== Update mapping API + +Adds new fields to an existing data stream or index. You can also use the API to +change the search settings of existing fields. [id="{upid}-{api}-request"] -==== Put Mapping Request +==== Request A +{request}+ requires an `index` argument: @@ -63,7 +66,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout] include::../execution.asciidoc[] [id="{upid}-{api}-response"] -==== Put Mapping Response +==== Response The returned +{response}+ allows to retrieve information about the executed operation as follows: diff --git a/docs/java-rest/high-level/indices/put_template.asciidoc b/docs/java-rest/high-level/indices/put_template.asciidoc index 3e3954308736..f10ddd0b543c 100644 --- a/docs/java-rest/high-level/indices/put_template.asciidoc +++ b/docs/java-rest/high-level/indices/put_template.asciidoc @@ -5,10 +5,10 @@ -- [id="{upid}-{api}"] -=== Put Template API +=== Create or update index template API [id="{upid}-{api}-request"] -==== Put Index Template Request +==== Request A +{request}+ specifies the `name` of a template and `patterns` which controls whether the template should be applied to the new index. @@ -120,7 +120,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout] include::../execution.asciidoc[] [id="{upid}-{api}-response"] -==== Put Index Template Response +==== Response The returned +{response}+ allows to retrieve information about the executed operation as follows: diff --git a/docs/java-rest/high-level/ingest/put_pipeline.asciidoc b/docs/java-rest/high-level/ingest/put_pipeline.asciidoc index 12a4eb15bce6..50dc049ae58d 100644 --- a/docs/java-rest/high-level/ingest/put_pipeline.asciidoc +++ b/docs/java-rest/high-level/ingest/put_pipeline.asciidoc @@ -1,8 +1,8 @@ [[java-rest-high-ingest-put-pipeline]] -=== Put Pipeline API +=== Create or update pipeline API [[java-rest-high-ingest-put-pipeline-request]] -==== Put Pipeline Request +==== Request A `PutPipelineRequest` requires an `id` argument, a source and a `XContentType`. The source consists of a description and a list of `Processor` objects. @@ -44,9 +44,9 @@ include-tagged::{doc-tests}/IngestClientDocumentationIT.java[put-pipeline-execut [[java-rest-high-ingest-put-pipeline-async]] ==== Asynchronous Execution -The asynchronous execution of a put pipeline request requires both the `PutPipelineRequest` -instance and an `ActionListener` instance to be passed to the asynchronous -method: +The asynchronous execution of a create or update pipeline request requires both +the `PutPipelineRequest` instance and an `ActionListener` instance to be passed +to the asynchronous method: ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -71,7 +71,7 @@ provided as an argument <2> Called in case of failure. The raised exception is provided as an argument [[java-rest-high-ingest-put-pipeline-response]] -==== Put Pipeline Response +==== Response The returned `WritePipelineResponse` allows to retrieve information about the executed operation as follows: diff --git a/docs/java-rest/high-level/ml/put-calendar-job.asciidoc b/docs/java-rest/high-level/ml/put-calendar-job.asciidoc index d13a4c597855..3bb3f69344a1 100644 --- a/docs/java-rest/high-level/ml/put-calendar-job.asciidoc +++ b/docs/java-rest/high-level/ml/put-calendar-job.asciidoc @@ -5,14 +5,14 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put {anomaly-jobs} in calendar API +=== Add {anomaly-jobs} to calendar API Adds {anomaly-jobs} jobs to an existing {ml} calendar. The API accepts a +{request}+ and responds with a +{response}+ object. [id="{upid}-{api}-request"] -==== Put {anomaly-jobs} in calendar request +==== Request A +{request}+ is constructed referencing a non-null calendar ID, and JobIDs to which to add to the calendar @@ -25,7 +25,7 @@ include-tagged::{doc-tests-file}[{api}-request] <2> The JobIds to add to the calendar [id="{upid}-{api}-response"] -==== Put {anomaly-jobs} in calendar response +==== Response The returned +{response}+ contains the updated calendar: diff --git a/docs/java-rest/high-level/ml/put-calendar.asciidoc b/docs/java-rest/high-level/ml/put-calendar.asciidoc index f37192ab634e..15ad58552115 100644 --- a/docs/java-rest/high-level/ml/put-calendar.asciidoc +++ b/docs/java-rest/high-level/ml/put-calendar.asciidoc @@ -5,14 +5,14 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put calendars API +=== Create calendars API Creates a new {ml} calendar. The API accepts a +{request}+ and responds with a +{response}+ object. [id="{upid}-{api}-request"] -==== Put calendars request +==== Request A +{request}+ is constructed with a calendar object @@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request] [id="{upid}-{api}-response"] -==== Put calendars response +==== Response The returned +{response}+ contains the created calendar: diff --git a/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc b/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc index 30914d539ce7..e65206122632 100644 --- a/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc +++ b/docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc @@ -5,7 +5,7 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put {dfanalytics-jobs} API +=== Create {dfanalytics-jobs} API beta::[] @@ -13,7 +13,7 @@ Creates a new {dfanalytics-job}. The API accepts a +{request}+ object as a request and returns a +{response}+. [id="{upid}-{api}-request"] -==== Put {dfanalytics-jobs} request +==== Request A +{request}+ requires the following argument: diff --git a/docs/java-rest/high-level/ml/put-datafeed.asciidoc b/docs/java-rest/high-level/ml/put-datafeed.asciidoc index a09ce1c784b7..e24b9c579a8a 100644 --- a/docs/java-rest/high-level/ml/put-datafeed.asciidoc +++ b/docs/java-rest/high-level/ml/put-datafeed.asciidoc @@ -5,13 +5,13 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put datafeeds API +=== Create datafeeds API Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object as a request and returns a +{response}+. [id="{upid}-{api}-request"] -==== Put datafeeds request +==== Request A +{request}+ requires the following argument: diff --git a/docs/java-rest/high-level/ml/put-filter.asciidoc b/docs/java-rest/high-level/ml/put-filter.asciidoc index f6de5e070113..1a8328e6930b 100644 --- a/docs/java-rest/high-level/ml/put-filter.asciidoc +++ b/docs/java-rest/high-level/ml/put-filter.asciidoc @@ -5,13 +5,13 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put filters API +=== Create filters API Creates a new {ml} filter in the cluster. The API accepts a +{request}+ object as a request and returns a +{response}+. [id="{upid}-{api}-request"] -==== Put filters request +==== Request A +{request}+ requires the following argument: diff --git a/docs/java-rest/high-level/ml/put-job.asciidoc b/docs/java-rest/high-level/ml/put-job.asciidoc index add7fcdc6e5a..ee0e0995911f 100644 --- a/docs/java-rest/high-level/ml/put-job.asciidoc +++ b/docs/java-rest/high-level/ml/put-job.asciidoc @@ -5,13 +5,13 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put {anomaly-jobs} API +=== Create {anomaly-jobs} API Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object as a request and returns a +{response}+. [id="{upid}-{api}-request"] -==== Put {anomaly-jobs} request +==== Request A +{request}+ requires the following argument: diff --git a/docs/java-rest/high-level/ml/put-trained-model-alias.asciidoc b/docs/java-rest/high-level/ml/put-trained-model-alias.asciidoc index be2c913d5562..c857f8e852a4 100644 --- a/docs/java-rest/high-level/ml/put-trained-model-alias.asciidoc +++ b/docs/java-rest/high-level/ml/put-trained-model-alias.asciidoc @@ -5,7 +5,7 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put trained model alias API +=== Create or update trained model alias API beta::[] @@ -15,7 +15,7 @@ The created trained model alias can then be used for other APIs in the stack instead of the referenced model id. [id="{upid}-{api}-request"] -==== Put trained model alias request +==== Request A +{request}+ requires the following arguments: diff --git a/docs/java-rest/high-level/ml/put-trained-model.asciidoc b/docs/java-rest/high-level/ml/put-trained-model.asciidoc index ba40a94a59bc..a1b791ae3cd6 100644 --- a/docs/java-rest/high-level/ml/put-trained-model.asciidoc +++ b/docs/java-rest/high-level/ml/put-trained-model.asciidoc @@ -5,7 +5,7 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put trained models API +=== Create trained models API beta::[] @@ -13,7 +13,7 @@ Creates a new trained model for inference. The API accepts a +{request}+ object as a request and returns a +{response}+. [id="{upid}-{api}-request"] -==== Put trained models request +==== Request A +{request}+ requires the following argument: diff --git a/docs/java-rest/high-level/rollup/put_job.asciidoc b/docs/java-rest/high-level/rollup/put_job.asciidoc index b43f257937c1..74884aa1ecf4 100644 --- a/docs/java-rest/high-level/rollup/put_job.asciidoc +++ b/docs/java-rest/high-level/rollup/put_job.asciidoc @@ -1,15 +1,15 @@ [role="xpack"] [[java-rest-high-x-pack-rollup-put-job]] -=== Put Rollup Job API +=== Create or update rollup job API experimental::[] -The Put Rollup Job API can be used to create a new Rollup job -in the cluster. The API accepts a `PutRollupJobRequest` object +Creates a new Rollup job or updates an existing one. +The API accepts a `PutRollupJobRequest` object as a request and returns a `PutRollupJobResponse`. [[java-rest-high-x-pack-rollup-put-rollup-job-request]] -==== Put Rollup Job Request +==== Request A `PutRollupJobRequest` requires the following argument: @@ -126,7 +126,7 @@ include-tagged::{doc-tests}/RollupDocumentationIT.java[x-pack-rollup-put-rollup- [[java-rest-high-x-pack-rollup-put-rollup-job-execution]] ==== Execution -The Put Rollup Job API can be executed through a `RollupClient` +The API can be called through a `RollupClient` instance. Such instance can be retrieved from a `RestHighLevelClient` using the `rollup()` method: diff --git a/docs/java-rest/high-level/script/put_script.asciidoc b/docs/java-rest/high-level/script/put_script.asciidoc index acc80e82d11e..e3c54e3cad2c 100644 --- a/docs/java-rest/high-level/script/put_script.asciidoc +++ b/docs/java-rest/high-level/script/put_script.asciidoc @@ -1,8 +1,8 @@ [[java-rest-high-put-stored-script]] -=== Put Stored Script API +=== Create or update stored script API [[java-rest-high-put-stored-script-request]] -==== Put Stored Script Request +==== Request A `PutStoredScriptRequest` requires an `id` and `content`: @@ -65,8 +65,9 @@ include-tagged::{doc-tests}/StoredScriptsDocumentationIT.java[put-stored-script- [[java-rest-high-put-stored-script-async]] ==== Asynchronous Execution -The asynchronous execution of a put stored script request requires both the `PutStoredScriptRequest` -instance and an `ActionListener` instance to be passed to the asynchronous method: +The asynchronous execution of a create or update stored script request requires +both the `PutStoredScriptRequest` instance and an `ActionListener` instance to +be passed to the asynchronous method: ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -94,7 +95,7 @@ provided as an argument <2> Called in case of failure. The raised exception is provided as an argument [[java-rest-high-put-stored-script-response]] -==== Put Stored Script Response +==== Response The returned `AcknowledgedResponse` allows to retrieve information about the executed operation as follows: diff --git a/docs/java-rest/high-level/security/put-privileges.asciidoc b/docs/java-rest/high-level/security/put-privileges.asciidoc index ba8d8878e157..72e28e698832 100644 --- a/docs/java-rest/high-level/security/put-privileges.asciidoc +++ b/docs/java-rest/high-level/security/put-privileges.asciidoc @@ -5,12 +5,12 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put Privileges API +=== Create or update privileges API Application privileges can be created or updated using this API. [id="{upid}-{api}-request"] -==== Put Privileges Request +==== Request A +{request}+ contains list of application privileges that need to be created or updated. Each application privilege consists of an application name, application privilege, @@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request] include::../execution.asciidoc[] [id="{upid}-{api}-response"] -==== Put Privileges Response +==== Response The returned +{response}+ contains the information about the status for each privilege present in the +{request}+. The status would be diff --git a/docs/java-rest/high-level/security/put-role-mapping.asciidoc b/docs/java-rest/high-level/security/put-role-mapping.asciidoc index 819aa776b68b..53e5a6ceaabd 100644 --- a/docs/java-rest/high-level/security/put-role-mapping.asciidoc +++ b/docs/java-rest/high-level/security/put-role-mapping.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[java-rest-high-security-put-role-mapping]] -=== Put Role Mapping API +=== Create or update role mapping API [[java-rest-high-security-put-role-mapping-execution]] ==== Execution diff --git a/docs/java-rest/high-level/security/put-role.asciidoc b/docs/java-rest/high-level/security/put-role.asciidoc index d418375237d4..41b5b9efd5b9 100644 --- a/docs/java-rest/high-level/security/put-role.asciidoc +++ b/docs/java-rest/high-level/security/put-role.asciidoc @@ -6,15 +6,15 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put Role API +=== Create or update role API [id="{upid}-{api}-request"] -==== Put Role Request +==== Request The +{request}+ class is used to create or update a role in the Native Roles Store. The request contains a single role, which encapsulates privileges over resources. A role can be assigned to an user using the -<<{upid}-put-role-mapping, Put Role Mapping API>>. +<<{upid}-put-role-mapping,Create or update role mapping API>>. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request] include::../execution.asciidoc[] [id="{upid}-{api}-response"] -==== Put Role Response +==== Response The returned +{response}+ contains a single field, `created`. This field serves as an indication if the role was created or if an existing entry was diff --git a/docs/java-rest/high-level/security/put-user.asciidoc b/docs/java-rest/high-level/security/put-user.asciidoc index 6d222cb06737..0af1d753c26c 100644 --- a/docs/java-rest/high-level/security/put-user.asciidoc +++ b/docs/java-rest/high-level/security/put-user.asciidoc @@ -5,10 +5,10 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put User API +=== Create or update user API [id="{upid}-{api}-request"] -==== Put User Request +==== Request The +{request}+ class is used to create or update a user in the Native Realm. There are 3 different factory methods for creating a request. @@ -46,7 +46,7 @@ include-tagged::{doc-tests-file}[{api}-update-request] include::../execution.asciidoc[] [id="{upid}-{api}-response"] -==== Put User Response +==== Response The returned `PutUserResponse` contains a single field, `created`. This field serves as an indication if a user was created or if an existing entry was updated. diff --git a/docs/java-rest/high-level/transform/put_transform.asciidoc b/docs/java-rest/high-level/transform/put_transform.asciidoc index 7d08d21a084a..bd41a662eee7 100644 --- a/docs/java-rest/high-level/transform/put_transform.asciidoc +++ b/docs/java-rest/high-level/transform/put_transform.asciidoc @@ -5,14 +5,14 @@ -- [role="xpack"] [id="{upid}-{api}"] -=== Put {transform} API +=== Create {transform} API Creates a new {transform}. The API accepts a +{request}+ object as a request and returns a +{response}+. [id="{upid}-{api}-request"] -==== Put {transform} request +==== Create {transform} request A +{request}+ requires the following argument: diff --git a/docs/java-rest/high-level/watcher/execute-watch.asciidoc b/docs/java-rest/high-level/watcher/execute-watch.asciidoc index b23b0918589d..4884b30ca7d2 100644 --- a/docs/java-rest/high-level/watcher/execute-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/execute-watch.asciidoc @@ -7,9 +7,9 @@ [id="{upid}-{api}"] === Execute watch API -The execute watch API allows clients to immediately execute a watch, either -one that has been previously added via the -{ref}/watcher-api-put-watch.html[Put Watch API] or inline as part of the request. +The execute watch API allows clients to immediately execute a watch, either one +that has been previously added via the {ref}/watcher-api-put-watch.html[create +or update watch API] or inline as part of the request. [id="{upid}-{api}-request-by-id"] ==== Execute by id diff --git a/docs/java-rest/high-level/watcher/put-watch.asciidoc b/docs/java-rest/high-level/watcher/put-watch.asciidoc index f3ab52181f26..c6a02a75e38c 100644 --- a/docs/java-rest/high-level/watcher/put-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/put-watch.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[java-rest-high-x-pack-watcher-put-watch]] -=== Put watch API +=== Create or update watch API [[java-rest-high-x-pack-watcher-put-watch-execution]] ==== Execution diff --git a/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc b/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc index 22ff05317a4e..37e574df2560 100644 --- a/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc +++ b/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc @@ -12,12 +12,13 @@ You can use the following APIs to perform autoscaling operations. === Top-Level * <> +* <> * <> * <> -* <> // top-level +include::put-autoscaling-policy.asciidoc[] include::get-autoscaling-capacity.asciidoc[] include::delete-autoscaling-policy.asciidoc[] include::get-autoscaling-policy.asciidoc[] -include::put-autoscaling-policy.asciidoc[] + diff --git a/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc b/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc index 32aded02a206..67f0a1f02f05 100644 --- a/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc +++ b/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc @@ -1,14 +1,14 @@ [role="xpack"] [testenv="enterprise"] [[autoscaling-put-autoscaling-policy]] -=== Put autoscaling policy API +=== Create or update autoscaling policy API ++++ -Put autoscaling policy +Create or update autoscaling policy ++++ include::../autoscaling-designed-for-note.asciidoc[] -Put autoscaling policy. +Creates or updates an autoscaling policy. [[autoscaling-put-autoscaling-policy-request]] ==== {api-request-title} diff --git a/docs/reference/data-streams/change-mappings-and-settings.asciidoc b/docs/reference/data-streams/change-mappings-and-settings.asciidoc index 9bbbc74f0e89..329bc4de49cf 100644 --- a/docs/reference/data-streams/change-mappings-and-settings.asciidoc +++ b/docs/reference/data-streams/change-mappings-and-settings.asciidoc @@ -93,7 +93,7 @@ field mapping is added to future backing indices created for the stream. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request adds a mapping +The following <> request adds a mapping for a new field, `message`, to the template. [source,console] @@ -117,12 +117,12 @@ PUT /_index_template/my-data-stream-template <1> Adds a mapping for the new `message` field. -- -. Use the <> to add the new field mapping +. Use the <> to add the new field mapping to the data stream. By default, this adds the mapping to the stream's existing backing indices, including the write index. + -- -The following put mapping API request adds the new `message` field mapping to +The following update mapping API request adds the new `message` field mapping to `my-data-stream`. [source,console] @@ -138,11 +138,11 @@ PUT /my-data-stream/_mapping ---- -- + -To add the mapping only to the stream's write index, set the put mapping API's +To add the mapping only to the stream's write index, set the update mapping API's `write_index_only` query parameter to `true`. + -- -The following put mapping request adds the new `message` field mapping only to +The following update mapping request adds the new `message` field mapping only to `my-data-stream`'s write index. The new field mapping is not added to the stream's other backing indices. @@ -165,7 +165,7 @@ PUT /my-data-stream/_mapping?write_index_only=true The documentation for each <> indicates whether you can update it for an existing field using the -<>. To update these parameters for an +<>. To update these parameters for an existing field, follow these steps: . Update the index template used by the data stream. This ensures the updated @@ -175,7 +175,7 @@ field mapping is added to future backing indices created for the stream. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request changes the +The following <> request changes the argument for the `host.ip` field's <> mapping parameter to `true`. @@ -205,12 +205,12 @@ PUT /_index_template/my-data-stream-template <1> Changes the `host.ip` field's `ignore_malformed` value to `true`. -- -. Use the <> to apply the mapping changes +. Use the <> to apply the mapping changes to the data stream. By default, this applies the changes to the stream's existing backing indices, including the write index. + -- -The following <> request targets +The following <> request targets `my-data-stream`. The request changes the argument for the `host.ip` field's `ignore_malformed` mapping parameter to `true`. @@ -236,7 +236,7 @@ To apply the mapping changes only to the stream's write index, set the put mapping API's `write_index_only` query parameter to `true`. + -- -The following put mapping request changes the `host.ip` field's mapping only for +The following update mapping request changes the `host.ip` field's mapping only for `my-data-stream`'s write index. The change is not applied to the stream's other backing indices. @@ -281,7 +281,7 @@ applied to future backing indices created for the stream. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request changes the +The following <> request changes the template's `index.refresh_interval` index setting to `30s` (30 seconds). [source,console] @@ -335,8 +335,8 @@ backing index created after the update. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> requests adds new -`sort.field` and `sort.order index` settings to the template. +The following <> requests +adds new `sort.field` and `sort.order index` settings to the template. [source,console] ---- @@ -428,10 +428,10 @@ new template by copying an existing one and modifying it as needed. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request creates a new -index template, `new-data-stream-template`. `new-data-stream-template` -uses `my-data-stream-template` as its basis, with the following -changes: +The following <> request +creates a new index template, `new-data-stream-template`. +`new-data-stream-template` uses `my-data-stream-template` as its basis, with the +following changes: * The index pattern in `index_patterns` matches any index or data stream starting with `new-data-stream`. diff --git a/docs/reference/data-streams/set-up-a-data-stream.asciidoc b/docs/reference/data-streams/set-up-a-data-stream.asciidoc index f846b2e1ef24..5c30ac2e2774 100644 --- a/docs/reference/data-streams/set-up-a-data-stream.asciidoc +++ b/docs/reference/data-streams/set-up-a-data-stream.asciidoc @@ -129,8 +129,8 @@ image::images/data-streams/create-index-template.png[Create template page] [%collapsible] .API example ==== -Use the <> to create an index -template. The template must include a `data_stream` object, indicating +Use the <> to create +an index template. The template must include a `data_stream` object, indicating it's used for data streams. [source,console] diff --git a/docs/reference/docs/index_.asciidoc b/docs/reference/docs/index_.asciidoc index 907c348b4eed..2198fa848c26 100644 --- a/docs/reference/docs/index_.asciidoc +++ b/docs/reference/docs/index_.asciidoc @@ -208,7 +208,7 @@ include::{es-repo-dir}/indices/index-templates.asciidoc[tag=built-in-index-templ If no mapping exists, the index operation creates a dynamic mapping. By default, new fields and objects are automatically added to the mapping if needed. For more information about field -mapping, see <> and the <> API. +mapping, see <> and the <> API. Automatic index creation is controlled by the `action.auto_create_index` setting. This setting defaults to `true`, which allows any index to be created diff --git a/docs/reference/glossary.asciidoc b/docs/reference/glossary.asciidoc index 50d4bdf70461..7e4064e1e5c4 100644 --- a/docs/reference/glossary.asciidoc +++ b/docs/reference/glossary.asciidoc @@ -280,7 +280,7 @@ An index alias is a logical name used to reference one or more indices. Most {es} APIs accept an index alias in place of an index name. // end::index-alias-desc[] -See {ref}/indices-add-alias.html[Add index alias]. +See {ref}/indices-add-alias.html[Create or update index alias API]. // end::index-alias-def[] -- diff --git a/docs/reference/ilm/ilm-tutorial.asciidoc b/docs/reference/ilm/ilm-tutorial.asciidoc index 79953d99b692..e17951c650b8 100644 --- a/docs/reference/ilm/ilm-tutorial.asciidoc +++ b/docs/reference/ilm/ilm-tutorial.asciidoc @@ -56,7 +56,7 @@ reaches either a `max_primary_shard_size` of 50 gigabytes or a `max_age` of 30 d Note that this value is relative to the rollover time, not the index creation time. You can create the policy through {kib} or with the -<> API. +<> API. To create the policy from {kib}, open the menu and go to *Stack Management > Index Lifecycle Policies*. Click *Create policy*. @@ -116,8 +116,8 @@ Templates* tab, click *Create template*. image::images/data-streams/create-index-template.png[Create template page] -This wizard invokes the <> to create -the index template with the options you specify. +This wizard invokes the <> to create the index template with the options you specify. .API example [%collapsible] diff --git a/docs/reference/ilm/set-up-lifecycle-policy.asciidoc b/docs/reference/ilm/set-up-lifecycle-policy.asciidoc index e911b28eda44..c22135fce8c9 100644 --- a/docs/reference/ilm/set-up-lifecycle-policy.asciidoc +++ b/docs/reference/ilm/set-up-lifecycle-policy.asciidoc @@ -35,7 +35,8 @@ image:images/ilm/create-policy.png[Create policy page] You specify the lifecycle phases for the policy and the actions to perform in each phase. -The <> API is invoked to add the policy to the {es} cluster. +The <> API is invoked to add the +policy to the {es} cluster. .API example [%collapsible] @@ -83,7 +84,8 @@ wizard, open the menu and go to *Stack Management > Index Management*. In the [role="screenshot"] image:images/ilm/create-template-wizard-my_template.png[Create template page] -The wizard invokes the <> to add templates to a cluster. +The wizard invokes the <> to add templates to a cluster. .API example [%collapsible] diff --git a/docs/reference/index-modules/mapper.asciidoc b/docs/reference/index-modules/mapper.asciidoc index 484aec184661..2bec352b9891 100644 --- a/docs/reference/index-modules/mapper.asciidoc +++ b/docs/reference/index-modules/mapper.asciidoc @@ -2,7 +2,7 @@ == Mapper The mapper module acts as a registry for the type mapping definitions -added to an index either when creating it or by using the put mapping -api. It also handles the dynamic mapping support for types that have no +added to an index either when creating it or by using the update mapping +API. It also handles the dynamic mapping support for types that have no explicit mappings pre defined. For more information about mapping definitions, check out the <>. diff --git a/docs/reference/indices.asciidoc b/docs/reference/indices.asciidoc index f01d96a3568b..039c6d711bba 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -91,96 +91,50 @@ For more information, see <>. -include::indices/add-alias.asciidoc[] - include::indices/analyze.asciidoc[] - -include::indices/clearcache.asciidoc[] - -include::indices/clone-index.asciidoc[] - -include::indices/close.asciidoc[] - -include::indices/create-index.asciidoc[] - -include::indices/delete-index.asciidoc[] - -include::indices/delete-alias.asciidoc[] - -include::indices/delete-component-template.asciidoc[] - -include::indices/delete-index-template.asciidoc[] - -include::indices/delete-index-template-v1.asciidoc[] - -include::indices/flush.asciidoc[] - -include::indices/forcemerge.asciidoc[] - -include::indices/apis/freeze.asciidoc[] - -include::indices/get-component-template.asciidoc[] - -include::indices/get-field-mapping.asciidoc[] - -include::indices/get-index.asciidoc[] - -include::indices/get-alias.asciidoc[] - -include::indices/get-settings.asciidoc[] - -include::indices/get-index-template.asciidoc[] - -include::indices/get-index-template-v1.asciidoc[] - -include::indices/get-mapping.asciidoc[] - -include::indices/alias-exists.asciidoc[] - -include::indices/indices-exists.asciidoc[] - -include::indices/recovery.asciidoc[] - -include::indices/segments.asciidoc[] - -include::indices/shard-stores.asciidoc[] - -include::indices/stats.asciidoc[] - -include::indices/index-template-exists-v1.asciidoc[] - -include::indices/open-close.asciidoc[] - -include::indices/put-index-template.asciidoc[] - -include::indices/put-index-template-v1.asciidoc[] - -include::indices/put-component-template.asciidoc[] - -include::indices/put-mapping.asciidoc[] - -include::indices/refresh.asciidoc[] - -include::indices/rollover-index.asciidoc[] - -include::indices/shrink-index.asciidoc[] - -include::indices/simulate-index.asciidoc[] - -include::indices/simulate-template.asciidoc[] - -include::indices/split-index.asciidoc[] - -include::indices/apis/unfreeze.asciidoc[] - include::indices/aliases.asciidoc[] - -include::indices/update-settings.asciidoc[] - -include::indices/resolve.asciidoc[] - -include::indices/dangling-indices-list.asciidoc[] - -include::indices/dangling-index-import.asciidoc[] - +include::indices/clearcache.asciidoc[] +include::indices/clone-index.asciidoc[] +include::indices/close.asciidoc[] +include::indices/create-index.asciidoc[] +include::indices/put-component-template.asciidoc[] +include::indices/add-alias.asciidoc[] +include::indices/put-index-template.asciidoc[] +include::indices/put-index-template-v1.asciidoc[] +include::indices/delete-component-template.asciidoc[] include::indices/dangling-index-delete.asciidoc[] +include::indices/delete-index.asciidoc[] +include::indices/delete-alias.asciidoc[] +include::indices/delete-index-template.asciidoc[] +include::indices/delete-index-template-v1.asciidoc[] +include::indices/flush.asciidoc[] +include::indices/forcemerge.asciidoc[] +include::indices/apis/freeze.asciidoc[] +include::indices/get-component-template.asciidoc[] +include::indices/get-field-mapping.asciidoc[] +include::indices/get-index.asciidoc[] +include::indices/get-alias.asciidoc[] +include::indices/get-settings.asciidoc[] +include::indices/get-index-template.asciidoc[] +include::indices/get-index-template-v1.asciidoc[] +include::indices/get-mapping.asciidoc[] +include::indices/dangling-index-import.asciidoc[] +include::indices/alias-exists.asciidoc[] +include::indices/indices-exists.asciidoc[] +include::indices/recovery.asciidoc[] +include::indices/segments.asciidoc[] +include::indices/shard-stores.asciidoc[] +include::indices/stats.asciidoc[] +include::indices/index-template-exists-v1.asciidoc[] +include::indices/dangling-indices-list.asciidoc[] +include::indices/open-close.asciidoc[] +include::indices/refresh.asciidoc[] +include::indices/resolve.asciidoc[] +include::indices/rollover-index.asciidoc[] +include::indices/shrink-index.asciidoc[] +include::indices/simulate-index.asciidoc[] +include::indices/simulate-template.asciidoc[] +include::indices/split-index.asciidoc[] +include::indices/apis/unfreeze.asciidoc[] +include::indices/update-settings.asciidoc[] +include::indices/put-mapping.asciidoc[] diff --git a/docs/reference/indices/add-alias.asciidoc b/docs/reference/indices/add-alias.asciidoc index 4f81608f00e4..e3fc4e071198 100644 --- a/docs/reference/indices/add-alias.asciidoc +++ b/docs/reference/indices/add-alias.asciidoc @@ -1,7 +1,7 @@ [[indices-add-alias]] -=== Add index alias API +=== Create or update index alias API ++++ -Add index alias +Create or update index alias ++++ Creates or updates an index alias. diff --git a/docs/reference/indices/aliases.asciidoc b/docs/reference/indices/aliases.asciidoc index 20c8ebb94167..db4bc2b81f39 100644 --- a/docs/reference/indices/aliases.asciidoc +++ b/docs/reference/indices/aliases.asciidoc @@ -1,12 +1,14 @@ [[indices-aliases]] -=== Update index alias API +=== Bulk index alias API ++++ -Update index alias +Bulk index alias ++++ -Adds or removes index aliases. +Adds and removes multiple index aliases in a single request. Also deletes +concrete indices. -include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc] +An index alias is a secondary name used to refer to one or more existing +indices. Most {es} APIs accept an index alias in place of an index. [source,console] ---- diff --git a/docs/reference/indices/put-component-template.asciidoc b/docs/reference/indices/put-component-template.asciidoc index 422904c6c5ff..e42e5166f5d8 100644 --- a/docs/reference/indices/put-component-template.asciidoc +++ b/docs/reference/indices/put-component-template.asciidoc @@ -1,7 +1,7 @@ [[indices-component-template]] -=== Put component template API +=== Create or update component template API ++++ -Put component template +Create or update component template ++++ Creates or updates a component template. diff --git a/docs/reference/indices/put-index-template-v1.asciidoc b/docs/reference/indices/put-index-template-v1.asciidoc index 0ca1ba7d5f5b..c0e487ca0eca 100644 --- a/docs/reference/indices/put-index-template-v1.asciidoc +++ b/docs/reference/indices/put-index-template-v1.asciidoc @@ -1,7 +1,7 @@ [[indices-templates-v1]] -=== Put index template API +=== Create or update index template API ++++ -Put index template (legacy) +Create or update index template (legacy) ++++ IMPORTANT: This documentation is about legacy index templates, @@ -62,9 +62,6 @@ privilege>> to use this API. [[put-index-template-v1-api-desc]] ==== {api-description-title} -Use the PUT index template API -to create or update an index template. - Index templates define <> and <> that you can automatically apply when creating new indices. {es} applies templates to new indices diff --git a/docs/reference/indices/put-index-template.asciidoc b/docs/reference/indices/put-index-template.asciidoc index 7967409cdb92..6d1074214150 100644 --- a/docs/reference/indices/put-index-template.asciidoc +++ b/docs/reference/indices/put-index-template.asciidoc @@ -1,7 +1,7 @@ [[indices-put-template]] -=== Put index template API +=== Create or update index template API ++++ -Put index template +Create or update index template ++++ Creates or updates an index template. diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index 91fd94af0187..5e3846caf9c9 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -1,11 +1,11 @@ [[indices-put-mapping]] -=== Put mapping API +=== Update mapping API ++++ -Put mapping +Update mapping ++++ -Adds new fields to an existing data stream or index. You can also use the -put mapping API to change the search settings of existing fields. +Adds new fields to an existing data stream or index. You can also use this +API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default. @@ -98,7 +98,7 @@ For existing fields, see <>. [[put-field-mapping-api-basic-ex]] ===== Example with single target -The put mapping API requires an existing data stream or index. The following +The update mapping API requires an existing data stream or index. The following <> API request creates the `publications` index with no mapping. @@ -107,7 +107,7 @@ index with no mapping. PUT /publications ---- -The following put mapping API request adds `title`, a new <> field, +The following update mapping API request adds `title`, a new <> field, to the `publications` index. [source,console] @@ -124,7 +124,7 @@ PUT /publications/_mapping [[put-mapping-api-multi-ex]] ===== Multiple targets -The PUT mapping API can be applied to multiple data streams or indices with a single request. +The update mapping API can be applied to multiple data streams or indices with a single request. For example, you can update mappings for the `my-index-000001` and `my-index-000002` indices at the same time: [source,console] @@ -152,7 +152,7 @@ PUT /my-index-000001,my-index-000002/_mapping [[add-new-field-to-object]] ===== Add new properties to an existing object field -You can use the put mapping API to add new properties to an existing +You can use the update mapping API to add new properties to an existing <> field. To see how this works, try the following example. Use the <> API to create an index with the @@ -176,7 +176,7 @@ PUT /my-index-000001 } ---- -Use the put mapping API to add a new inner `last` text field to the `name` +Use the update mapping API to add a new inner `last` text field to the `name` field. [source,console] @@ -201,7 +201,7 @@ PUT /my-index-000001/_mapping ===== Add multi-fields to an existing field <> let you index the same field in different ways. -You can use the put mapping API to update the `fields` mapping parameter and +You can use the update mapping API to update the `fields` mapping parameter and enable multi-fields for an existing field. To see how this works, try the following example. @@ -226,7 +226,7 @@ PUT /my-index-000001 While text fields work well for full-text search, <> fields are not analyzed and may work better for sorting or aggregations. -Use the put mapping API to enable a multi-field for the `city` field. This +Use the update mapping API to enable a multi-field for the `city` field. This request adds the `city.raw` keyword multi-field, which can be used for sorting. [source,console] @@ -252,8 +252,8 @@ PUT /my-index-000001/_mapping ===== Change supported mapping parameters for an existing field The documentation for each <> indicates -whether you can update it for an existing field using the put mapping API. For -example, you can use the put mapping API to update the +whether you can update it for an existing field using the update mapping API. For +example, you can use the update mapping API to update the <> parameter. To see how this works, try the following example. @@ -277,7 +277,7 @@ PUT /my-index-000001 } ---- -Use the put mapping API to change the `ignore_above` parameter value to `100`. +Use the update mapping API to change the `ignore_above` parameter value to `100`. [source,console] ---- @@ -416,7 +416,7 @@ PUT /my-index-000001 } ---- -Use the put mapping API to add the `user_id` field alias +Use the update mapping API to add the `user_id` field alias for the existing `user_identifier` field. [source,console] diff --git a/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc index d9eab309f83d..1c87bbfc5523 100644 --- a/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc @@ -1,12 +1,12 @@ [role="xpack"] [testenv="basic"] [[put-enrich-policy-api]] -=== Put enrich policy API +=== Create or update enrich policy API ++++ -Put enrich policy +Create or update enrich policy ++++ -Creates an enrich policy. +Creates or updates an enrich policy. //// [source,console] @@ -64,8 +64,8 @@ If you use {es} {security-features}, you must have: [[put-enrich-policy-api-desc]] ==== {api-description-title} -Use the put enrich policy API -to create a new <>. +Use the create or update enrich policy API to create a new +<>. [WARNING] ==== diff --git a/docs/reference/ingest/apis/put-pipeline.asciidoc b/docs/reference/ingest/apis/put-pipeline.asciidoc index 6d6eb82ff1e0..2a79c67d52d7 100644 --- a/docs/reference/ingest/apis/put-pipeline.asciidoc +++ b/docs/reference/ingest/apis/put-pipeline.asciidoc @@ -1,7 +1,7 @@ [[put-pipeline-api]] -=== Put pipeline API +=== Create or update pipeline API ++++ -Put pipeline +Create or update pipeline ++++ Creates or updates an ingest pipeline. diff --git a/docs/reference/ingest/enrich.asciidoc b/docs/reference/ingest/enrich.asciidoc index a6a488072558..991881aaf12d 100644 --- a/docs/reference/ingest/enrich.asciidoc +++ b/docs/reference/ingest/enrich.asciidoc @@ -143,7 +143,7 @@ policy, you should include at least the following: include::enrich.asciidoc[tag=enrich-policy-fields] You can use this definition to create the enrich policy with the -<>. +<>. [WARNING] ==== @@ -172,7 +172,7 @@ your policy. image::images/ingest/enrich/enrich-processor.svg[align="center"] Define an <> and add it to an ingest -pipeline using the <>. +pipeline using the <>. When defining the enrich processor, you must include at least the following: @@ -343,8 +343,8 @@ PUT /postal_codes/_doc/1?refresh=wait_for ---- // TEST[continued] -Use the <> to create an enrich -policy with the `geo_match` policy type. This policy must include: +Use the <> to create +an enrich policy with the `geo_match` policy type. This policy must include: * One or more source indices * A `match_field`, @@ -374,8 +374,9 @@ POST /_enrich/policy/postal_policy/_execute ---- // TEST[continued] -Use the <> to create an ingest pipeline. In -the pipeline, add an <> that includes: +Use the <> to create an ingest +pipeline. In the pipeline, add an <> that +includes: * Your enrich policy. * The `field` of incoming documents used to match the geo_shape of documents @@ -499,8 +500,8 @@ PUT /users/_doc/1?refresh=wait_for } ---- -Use the put enrich policy API to create an enrich policy with the `match` -policy type. This policy must include: +Use the create or update enrich policy API to create an enrich policy with the +`match` policy type. This policy must include: * One or more source indices * A `match_field`, @@ -531,8 +532,9 @@ POST /_enrich/policy/users-policy/_execute // TEST[continued] -Use the <> to create an ingest pipeline. In -the pipeline, add an <> that includes: +Use the <> to create an ingest +pipeline. In the pipeline, add an <> that +includes: * Your enrich policy. * The `field` of incoming documents used to match documents diff --git a/docs/reference/mapping/dynamic/field-mapping.asciidoc b/docs/reference/mapping/dynamic/field-mapping.asciidoc index 9c47bd32d96b..309a231a60af 100644 --- a/docs/reference/mapping/dynamic/field-mapping.asciidoc +++ b/docs/reference/mapping/dynamic/field-mapping.asciidoc @@ -36,7 +36,7 @@ You can disable dynamic mapping, both at the document and at the `false` ignores new fields, and `strict` rejects the document if {es} encounters an unknown field. -TIP: Use the <> to update the `dynamic` +TIP: Use the <> to update the `dynamic` setting on existing fields. You can customize dynamic field mapping rules for diff --git a/docs/reference/mapping/dynamic/templates.asciidoc b/docs/reference/mapping/dynamic/templates.asciidoc index 6151bdbc86a5..80760e2a85cb 100644 --- a/docs/reference/mapping/dynamic/templates.asciidoc +++ b/docs/reference/mapping/dynamic/templates.asciidoc @@ -61,7 +61,7 @@ snippet may cause the update or validation of a dynamic template to fail under c at index time. Templates are processed in order -- the first matching template wins. When -putting new dynamic templates through the <> API, +putting new dynamic templates through the <> API, all existing templates are overwritten. This allows for dynamic templates to be reordered or deleted after they were initially added. diff --git a/docs/reference/mapping/explicit-mapping.asciidoc b/docs/reference/mapping/explicit-mapping.asciidoc index 4ef055d5699c..ba2d9ec16676 100644 --- a/docs/reference/mapping/explicit-mapping.asciidoc +++ b/docs/reference/mapping/explicit-mapping.asciidoc @@ -38,7 +38,7 @@ PUT /my-index-000001 [[add-field-mapping]] === Add a field to an existing mapping -You can use the <> API to add one or more new +You can use the <> API to add one or more new fields to an existing index. The following example adds `employee-id`, a `keyword` field with an diff --git a/docs/reference/mapping/fields/meta-field.asciidoc b/docs/reference/mapping/fields/meta-field.asciidoc index 141a5de7258d..64113f3766de 100644 --- a/docs/reference/mapping/fields/meta-field.asciidoc +++ b/docs/reference/mapping/fields/meta-field.asciidoc @@ -25,7 +25,7 @@ PUT my-index-000001 <> API. The `_meta` field can be updated on an existing type using the -<> API: +<> API: [source,console] -------------------------------------------------- diff --git a/docs/reference/mapping/params/analyzer.asciidoc b/docs/reference/mapping/params/analyzer.asciidoc index e845fe79b9d9..94bf68c47d20 100644 --- a/docs/reference/mapping/params/analyzer.asciidoc +++ b/docs/reference/mapping/params/analyzer.asciidoc @@ -20,7 +20,7 @@ We recommend testing analyzers before using them in production. See ==== TIP: The `analyzer` setting can *not* be updated on existing fields -using the <>. +using the <>. [[search-quote-analyzer]] ==== `search_quote_analyzer` @@ -98,7 +98,7 @@ GET my-index-000001/_search -------------------------------------------------- TIP: The `search_quote_analyzer` setting can be updated on existing fields -using the <>. +using the <>. <1> `my_analyzer` analyzer which tokens all terms including stop words <2> `my_stop_analyzer` analyzer which removes stop words diff --git a/docs/reference/mapping/params/coerce.asciidoc b/docs/reference/mapping/params/coerce.asciidoc index 805dd33bcf4b..bd048a288018 100644 --- a/docs/reference/mapping/params/coerce.asciidoc +++ b/docs/reference/mapping/params/coerce.asciidoc @@ -48,7 +48,7 @@ PUT my-index-000001/_doc/2 <2> This document will be rejected because coercion is disabled. TIP: The `coerce` setting value can be updated on existing fields -using the <>. +using the <>. [[coerce-setting]] ==== Index-level default diff --git a/docs/reference/mapping/params/ignore-above.asciidoc b/docs/reference/mapping/params/ignore-above.asciidoc index d144e4ef9ea8..7d04bc82dcbb 100644 --- a/docs/reference/mapping/params/ignore-above.asciidoc +++ b/docs/reference/mapping/params/ignore-above.asciidoc @@ -48,7 +48,7 @@ GET my-index-000001/_search <4> <4> Search returns both documents, but only the first is present in the terms aggregation. TIP: The `ignore_above` setting can be updated on -existing fields using the <>. +existing fields using the <>. This option is also useful for protecting against Lucene's term byte-length limit of `32766`. diff --git a/docs/reference/mapping/params/ignore-malformed.asciidoc b/docs/reference/mapping/params/ignore-malformed.asciidoc index 69f66a0681c4..1db2a8cde897 100644 --- a/docs/reference/mapping/params/ignore-malformed.asciidoc +++ b/docs/reference/mapping/params/ignore-malformed.asciidoc @@ -56,7 +56,7 @@ The `ignore_malformed` setting is currently supported by the following <>:: `ip` for IPv4 and IPv6 addresses TIP: The `ignore_malformed` setting value can be updated on -existing fields using the <>. +existing fields using the <>. [[ignore-malformed-setting]] ==== Index-level default diff --git a/docs/reference/mapping/params/multi-fields.asciidoc b/docs/reference/mapping/params/multi-fields.asciidoc index fcf828db8909..3045103d82d5 100644 --- a/docs/reference/mapping/params/multi-fields.asciidoc +++ b/docs/reference/mapping/params/multi-fields.asciidoc @@ -61,7 +61,7 @@ GET my-index-000001/_search NOTE: Multi-fields do not change the original `_source` field. TIP: New multi-fields can be added to existing -fields using the <>. +fields using the <>. ==== Multi-fields with multiple analyzers diff --git a/docs/reference/mapping/params/norms.asciidoc b/docs/reference/mapping/params/norms.asciidoc index 303c2af5ecc1..ce1097e29c9d 100644 --- a/docs/reference/mapping/params/norms.asciidoc +++ b/docs/reference/mapping/params/norms.asciidoc @@ -12,10 +12,10 @@ field. In particular, this is the case for fields that are used solely for filtering or aggregations. TIP: Norms can be disabled on existing fields using -the <>. +the <>. Norms can be disabled (but not reenabled after the fact), using the -<> like so: +<> like so: [source,console] ------------ diff --git a/docs/reference/mapping/params/properties.asciidoc b/docs/reference/mapping/params/properties.asciidoc index 1f3330062c22..399e79d81306 100644 --- a/docs/reference/mapping/params/properties.asciidoc +++ b/docs/reference/mapping/params/properties.asciidoc @@ -7,7 +7,7 @@ contain sub-fields, called `properties`. These properties may be of any be added: * explicitly by defining them when <>. -* explicitly by defining them when adding or updating a mapping type with the <> API. +* explicitly by defining them when adding or updating a mapping type with the <> API. * <> just by indexing documents containing new fields. Below is an example of adding `properties` to a mapping type, an `object` @@ -63,7 +63,7 @@ PUT my-index-000001/_doc/1 <4> TIP: The `properties` setting is allowed to have different settings for fields of the same name in the same index. New properties can be added to existing -fields using the <>. +fields using the <>. ==== Dot notation diff --git a/docs/reference/mapping/params/search-analyzer.asciidoc b/docs/reference/mapping/params/search-analyzer.asciidoc index 086bcc5ccec0..a0e707572039 100644 --- a/docs/reference/mapping/params/search-analyzer.asciidoc +++ b/docs/reference/mapping/params/search-analyzer.asciidoc @@ -76,5 +76,5 @@ See {defguide}/_index_time_search_as_you_type.html[Index time search-as-you- type] for a full explanation of this example. TIP: The `search_analyzer` setting can be updated on existing fields -using the <>. Note, that in order to do so, +using the <>. Note, that in order to do so, any existing "analyzer" setting and "type" need to be repeated in the updated field definition. diff --git a/docs/reference/mapping/types/flattened.asciidoc b/docs/reference/mapping/types/flattened.asciidoc index a793f5056052..42e7d4b54d6d 100644 --- a/docs/reference/mapping/types/flattened.asciidoc +++ b/docs/reference/mapping/types/flattened.asciidoc @@ -133,7 +133,7 @@ The following mapping parameters are accepted: The maximum allowed depth of the flattened object field, in terms of nested inner objects. If a flattened object field exceeds this limit, then an error will be thrown. Defaults to `20`. Note that `depth_limit` can be - updated dynamically through the <> API. + updated dynamically through the <> API. <>:: diff --git a/docs/reference/mapping/types/percolator.asciidoc b/docs/reference/mapping/types/percolator.asciidoc index 518f62c94bc4..ce3d3d93ff5d 100644 --- a/docs/reference/mapping/types/percolator.asciidoc +++ b/docs/reference/mapping/types/percolator.asciidoc @@ -53,7 +53,7 @@ PUT my-index-000001/_doc/match_value Fields referred to in a percolator query must *already* exist in the mapping associated with the index used for percolation. In order to make sure these fields exist, -add or update a mapping via the <> or <> APIs. +add or update a mapping via the <> or <> APIs. ===================================== diff --git a/docs/reference/mapping/types/text.asciidoc b/docs/reference/mapping/types/text.asciidoc index 1d29e8078195..9276468f0887 100644 --- a/docs/reference/mapping/types/text.asciidoc +++ b/docs/reference/mapping/types/text.asciidoc @@ -199,7 +199,7 @@ PUT my-index-000001 ==== Enabling fielddata on `text` fields You can enable fielddata on an existing `text` field using the -<> as follows: +<> as follows: [source,console] ----------------------------------- diff --git a/docs/reference/migration/migrate_8_0/indices.asciidoc b/docs/reference/migration/migrate_8_0/indices.asciidoc index 59a21bc7cad7..7ba4155a5f08 100644 --- a/docs/reference/migration/migrate_8_0/indices.asciidoc +++ b/docs/reference/migration/migrate_8_0/indices.asciidoc @@ -49,16 +49,16 @@ Discontinue use of the `index.force_memory_term_dictionary` index setting. Requests that include this setting will return an error. ==== -.The put index template API's `template` parameter has been removed. +.The create or update index template API's `template` parameter has been removed. [%collapsible] ==== *Details* + -In 6.0, we deprecated the `template` parameter in put index template requests -in favor of using `index_patterns`. Support for the `template` parameter is now -removed in 8.0. +In 6.0, we deprecated the `template` parameter in create or update index +template requests in favor of using `index_patterns`. Support for the `template` +parameter is now removed in 8.0. *Impact* + -Use the {ref}/indices-templates-v1.html[put index template API]'s +Use the {ref}/indices-templates-v1.html[create or update index template API]'s `index_patterns` parameter. Requests that include the `template` parameter will return an error. ==== diff --git a/docs/reference/migration/migrate_8_0/mappings.asciidoc b/docs/reference/migration/migrate_8_0/mappings.asciidoc index 0a06f26df096..4195b1888aeb 100644 --- a/docs/reference/migration/migrate_8_0/mappings.asciidoc +++ b/docs/reference/migration/migrate_8_0/mappings.asciidoc @@ -27,7 +27,7 @@ than 10 completion contexts will return an error. [%collapsible] ==== *Details* + -The typed REST endpoints of the Put Mapping, Get Mapping and Get Field mapping +The typed REST endpoints of the update mapping, get mapping and get field mapping APIs have been removed in favour of their typeless REST endpoints, since indexes no longer contain types, these typed endpoints are obsolete. diff --git a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc index e4a4f02ceb5a..6f1c15a7cf06 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc @@ -35,7 +35,7 @@ each interval. See {ml-docs}/ml-delayed-data-detection.html[Handling delayed dat [IMPORTANT] ==== -* You must use {kib} or this API to create a {dfeed}. Do not put a +* You must use {kib} or this API to create a {dfeed}. Do not add a {dfeed} directly to the `.ml-config` index using the {es} index API. If {es} {security-features} are enabled, do not give users `write` privileges on the `.ml-config` index. diff --git a/docs/reference/modules/discovery/discovery-settings.asciidoc b/docs/reference/modules/discovery/discovery-settings.asciidoc index 9aa11163225c..6c3efa94de4c 100644 --- a/docs/reference/modules/discovery/discovery-settings.asciidoc +++ b/docs/reference/modules/discovery/discovery-settings.asciidoc @@ -202,7 +202,7 @@ cluster. This setting has three valid values: -- `all`::: All operations on the node (both read and write operations) are rejected. This also applies for API cluster state read or write operations, like the get -index settings, put mapping and cluster state API. +index settings, update mapping, and cluster state API. `write`::: (default) Write operations are rejected. Read operations succeed, based on the last known cluster configuration. This situation may result in diff --git a/docs/reference/slm/apis/slm-put.asciidoc b/docs/reference/slm/apis/slm-put.asciidoc index ff11289f62f1..423b1bff33a0 100644 --- a/docs/reference/slm/apis/slm-put.asciidoc +++ b/docs/reference/slm/apis/slm-put.asciidoc @@ -1,7 +1,7 @@ [[slm-api-put-policy]] -=== Put snapshot lifecycle policy API +=== Create or update snapshot lifecycle policy API ++++ -Put policy +Create or update policy ++++ Creates or updates a snapshot lifecycle policy. @@ -23,7 +23,7 @@ For more information, see <>. [[slm-api-put-desc]] ==== {api-description-title} -Use the put snapshot lifecycle policy API +Use the create or update snapshot lifecycle policy API to create or update a snapshot lifecycle policy. If the policy already exists, diff --git a/docs/reference/slm/getting-started-slm.asciidoc b/docs/reference/slm/getting-started-slm.asciidoc index a0dfd0e3b0e2..5a5210e2a425 100644 --- a/docs/reference/slm/getting-started-slm.asciidoc +++ b/docs/reference/slm/getting-started-slm.asciidoc @@ -28,7 +28,7 @@ Remote repositories are generally used for production deployments. For this tutorial, you can register a local repository from {kibana-ref}/snapshot-repositories.html[{kib} Management] -or use the put repository API: +or use the create or update repository API: [source,console] ----------------------------------- @@ -55,12 +55,13 @@ automatically delete snapshots when they are no longer needed. TIP: Don't be afraid to configure a policy that takes frequent snapshots. Snapshots are incremental and make efficient use of storage. -You can define and manage policies through {kib} Management or with the put policy API. +You can define and manage policies through {kib} Management or with the create +or update policy API. For example, you could define a `nightly-snapshots` policy to back up all of your data streams and indices daily at 2:30AM UTC. -A put policy request defines the policy configuration in JSON: +A create or update policy request defines the policy configuration in JSON: [source,console] -------------------------------------------------- diff --git a/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc index 4f37947213fb..5b60575c85b6 100644 --- a/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc @@ -52,7 +52,9 @@ cluster, as well as the cluster state. You can change this behavior by specifying a list of data streams and indices to back up in the body of the snapshot request. -NOTE: You must register a snapshot repository before performing snapshot and restore operations. Use the <> to register new repositories and update existing ones. +NOTE: You must register a snapshot repository before performing snapshot and +restore operations. Use the <> to register new repositories and update existing ones. The snapshot process is incremental. When creating a snapshot, {es} analyzes the list of files that are already stored in the repository and copies only files that were created or changed since the last snapshot. This process allows multiple snapshots to be preserved in the repository in a compact form. diff --git a/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc index 72de7e16ad91..ac9629221dd5 100644 --- a/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc @@ -112,8 +112,9 @@ Contains settings for the repository. Valid properties for the `settings` object depend on the repository type, set using the <> parameter. + -For properties, see the <>'s -<>. +For properties, see the <>'s <>. ==== [[get-snapshot-repo-api-example]] diff --git a/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc index ce96f63ca653..fdf56d9f57d8 100644 --- a/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc @@ -1,7 +1,7 @@ [[put-snapshot-repo-api]] -=== Put snapshot repository API +=== Create or update snapshot repository API ++++ -Put snapshot repository +Create or update snapshot repository ++++ Registers or updates a <>. diff --git a/docs/reference/snapshot-restore/apis/snapshot-restore-apis.asciidoc b/docs/reference/snapshot-restore/apis/snapshot-restore-apis.asciidoc index 6e8e045e2f0d..ad8be3790e4f 100644 --- a/docs/reference/snapshot-restore/apis/snapshot-restore-apis.asciidoc +++ b/docs/reference/snapshot-restore/apis/snapshot-restore-apis.asciidoc @@ -9,7 +9,7 @@ For more information, see <>. [discrete] [[snapshot-restore-repo-apis]] === Snapshot repository management APIs -* <> +* <> * <> * <> * <> diff --git a/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc index 7df3cfbc55d5..8b784786336a 100644 --- a/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc @@ -39,13 +39,13 @@ POST /_snapshot/my_repository/_verify [[verify-snapshot-repo-api-desc]] ==== {api-description-title} -By default, <> requests -verify that a snapshot is functional on all master and data nodes in the -cluster. +By default, <> +requests verify that a snapshot is functional on all master and data nodes in +the cluster. -You can skip this verification using the put snapshot repository API's `verify` -parameter. You can then use the verify snapshot repository API to manually -verify the repository. +You can skip this verification using the create or update snapshot repository +API's `verify` parameter. You can then use the verify snapshot repository API to +manually verify the repository. If verification is successful, the verify snapshot repository API returns a list of nodes connected to the snapshot repository. If verification failed, the API diff --git a/docs/reference/snapshot-restore/register-repository.asciidoc b/docs/reference/snapshot-restore/register-repository.asciidoc index 3d62fdfa4eae..39c0a3235342 100644 --- a/docs/reference/snapshot-restore/register-repository.asciidoc +++ b/docs/reference/snapshot-restore/register-repository.asciidoc @@ -7,8 +7,10 @@ [[snapshots-register-repository-description]] // tag::snapshots-register-repository-tag[] You must register a snapshot repository before you can perform snapshot and -restore operations. Use the <> to register or update a snapshot repository. We recommend creating a new snapshot repository for each -major version. The valid repository settings depend on the repository type. +restore operations. Use the <> to register or update a snapshot repository. We recommend +creating a new snapshot repository for each major version. The valid repository +settings depend on the repository type. If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. All other clusters diff --git a/docs/reference/snapshot-restore/take-snapshot.asciidoc b/docs/reference/snapshot-restore/take-snapshot.asciidoc index f46d5e380447..d7c49de215f6 100644 --- a/docs/reference/snapshot-restore/take-snapshot.asciidoc +++ b/docs/reference/snapshot-restore/take-snapshot.asciidoc @@ -4,7 +4,10 @@ A repository can contain multiple snapshots of the same cluster. Snapshots are identified by unique names within the cluster. -Use the <> to register or update a snapshot repository, and then use the <> to create a snapshot in a repository. +Use the <> to +register or update a snapshot repository, and then use the +<> to create a snapshot in a +repository. The following request creates a snapshot with the name `snapshot_1` in the repository `my_backup`: diff --git a/docs/reference/tab-widgets/register-fs-repo.asciidoc b/docs/reference/tab-widgets/register-fs-repo.asciidoc index bbfeabcbf571..1a4cee7ec42c 100644 --- a/docs/reference/tab-widgets/register-fs-repo.asciidoc +++ b/docs/reference/tab-widgets/register-fs-repo.asciidoc @@ -9,9 +9,9 @@ path: - /mount/long_term_backups ---- -After restarting each node, use the <> API to register the file system repository. Specify the file -system's path in `settings.location`: +After restarting each node, use the <> API to register the file system repository. Specify the +file system's path in `settings.location`: [source,console] ---- @@ -64,9 +64,9 @@ path: <1> DOS path <2> UNC path -After restarting each node, use the <> API to register the file system repository. Specify the file -system's path in `settings.location`: +After restarting each node, use the <> API to register the file system repository. Specify the +file system's path in `settings.location`: [source,console] ---- diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index e1d46370d378..7982299ab988 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -56,7 +56,7 @@ creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the {transform} fails when it attempts unauthorized operations. -IMPORTANT: You must use {kib} or this API to create a {transform}. Do not put a +IMPORTANT: You must use {kib} or this API to create a {transform}. Do not add a {transform} directly into any `.transform-internal*` indices using the {es} index API. If {es} {security-features} are enabled, do not give users any privileges on `.transform-internal*` indices. If you used {transforms} prior to diff --git a/x-pack/docs/en/rest-api/logstash/index.asciidoc b/x-pack/docs/en/rest-api/logstash/index.asciidoc index fa5162cb8916..a52be19a75df 100644 --- a/x-pack/docs/en/rest-api/logstash/index.asciidoc +++ b/x-pack/docs/en/rest-api/logstash/index.asciidoc @@ -10,6 +10,6 @@ Management]: * <> * <> +include::put-pipeline.asciidoc[] include::delete-pipeline.asciidoc[] include::get-pipeline.asciidoc[] -include::put-pipeline.asciidoc[] diff --git a/x-pack/docs/en/rest-api/logstash/put-pipeline.asciidoc b/x-pack/docs/en/rest-api/logstash/put-pipeline.asciidoc index 74c831a28a1e..7854ad0c60eb 100644 --- a/x-pack/docs/en/rest-api/logstash/put-pipeline.asciidoc +++ b/x-pack/docs/en/rest-api/logstash/put-pipeline.asciidoc @@ -1,9 +1,9 @@ [role="xpack"] [testenv="basic"] [[logstash-api-put-pipeline]] -=== Put {ls} pipeline API +=== Create or update {ls} pipeline API ++++ -Put {ls} pipeline +Create or update {ls} pipeline ++++ This API creates or updates a {ls} pipeline used for diff --git a/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc b/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc index 3e610ffd880f..d30d635144bc 100644 --- a/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc +++ b/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc @@ -1,8 +1,8 @@ [role="xpack"] [[watcher-api-put-watch]] -=== Put watch API +=== Create or update watch API ++++ -Put watch +Create or update watch ++++ Either registers a new watch in {watcher} or updates an existing one. @@ -26,7 +26,7 @@ the `.watches` index and its trigger is immediately registered with the relevant trigger engine. Typically for the `schedule` trigger, the scheduler is the trigger engine. -IMPORTANT: You must use {kib} or this API to create a watch. Do not put a watch +IMPORTANT: You must use {kib} or this API to create a watch. Do not add a watch directly to the `.watches` index using the Elasticsearch index API. If {es} {security-features} are enabled, do not give users `write` privileges on the `.watches` index. diff --git a/x-pack/docs/en/security/auditing/event-types.asciidoc b/x-pack/docs/en/security/auditing/event-types.asciidoc index 009334f4bb34..b1048f9230c4 100644 --- a/x-pack/docs/en/security/auditing/event-types.asciidoc +++ b/x-pack/docs/en/security/auditing/event-types.asciidoc @@ -91,22 +91,22 @@ invoked to invalidate one or more API keys. | `{"type":"audit", "timestamp":"2020-12-31T00:36:30,247+0200", "node.id":"9clhpgjJRR-iKzOw20xBNQ", "event.type":"security_config_change", "event.action":"invalidate_apikeys", "request.id":"7lyIQU9QTFqSrTxD0CqnTQ", "invalidate":{"apikeys":{"owned_by_authenticated_user":false,"user":{"name":"myuser","realm":"native1"}}}}` | `put_privileges` -| Logged when the <> is invoked +| Logged when the <> is invoked to add or update one or more application privileges. | `{"type":"audit", "timestamp":"2020-12-31T00:39:07,779+0200", "node.id":"9clhpgjJRR-iKzOw20xBNQ", "event.type":"security_config_change", "event.action":"put_privileges", "request.id":"1X2VVtNgRYO7FmE0nR_BGA", "put":{"privileges":[{"application":"myapp","name":"read","actions":["data:read/*","action:login"],"metadata":{"description":"Read access to myapp"}}]}}` | `put_role` -| Logged when the <> is invoked to create or +| Logged when the <> is invoked to create or update a role. | `{"type":"audit", "timestamp":"2020-12-30T22:27:01,978+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_role", "request.id":"tDYQhv5CRMWM4Sc5Zkk2cQ", "put":{"role":{"name":"test_role","role_descriptor":{"cluster":["all"],"indices":[{"names":["apm*"],"privileges":["all"],"field_security":{"grant":["granted"]},"query":"{\"term\": {\"service.name\": \"bar\"}}"},{"names":["apm-all*"],"privileges":["all"],"query":"{\"term\": {\"service.name\": \"bar2\"}}"}],"applications":[],"run_as":[]}}}}` | `put_role_mapping` -| Logged when the <> is +| Logged when the <> is invoked to create or update a role mapping. | `{"type":"audit", "timestamp":"2020-12-31T00:11:13,932+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_role_mapping", "request.id":"kg4h1l_kTDegnLC-0A-XxA", "put":{"role_mapping":{"name":"mapping1","roles":["user"],"rules":{"field":{"username":"*"}},"enabled":true,"metadata":{"version":1}}}}` | `put_user` -| Logged when the <> is invoked to create or +| Logged when the <> is invoked to create or update a native user. Note that user updates can also change the user's password. | `{"type":"audit", "timestamp":"2020-12-30T22:10:09,749+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_user", "request.id":"VIiSvhp4Riim_tpkQCVSQA", "put":{"user":{"name":"user1","enabled":false,"roles":["admin","other_role1"],"full_name":"Jack Sparrow","email":"jack@blackpearl.com","has_password":true,"metadata":{"cunning":10}}}}` diff --git a/x-pack/docs/en/security/authorization/privileges.asciidoc b/x-pack/docs/en/security/authorization/privileges.asciidoc index a3cc4fe39aff..afbe2535a70e 100644 --- a/x-pack/docs/en/security/authorization/privileges.asciidoc +++ b/x-pack/docs/en/security/authorization/privileges.asciidoc @@ -213,7 +213,7 @@ non-existent index or data stream rather than an explicit auto-update of mappings on indices and data streams if they do not contradict existing mappings. An auto-update mapping action is the result of an index or bulk request on an index or data stream that contains new fields that may -be mapped rather than an explicit <> request. +be mapped rather than an explicit <> request. `create`:: Privilege to index documents. Also grants access to the update mapping diff --git a/x-pack/docs/en/watcher/how-watcher-works.asciidoc b/x-pack/docs/en/watcher/how-watcher-works.asciidoc index 862fce97c3f8..0d3878096d8c 100644 --- a/x-pack/docs/en/watcher/how-watcher-works.asciidoc +++ b/x-pack/docs/en/watcher/how-watcher-works.asciidoc @@ -43,9 +43,8 @@ Specify what happens when the watch condition is met. [[watch-definition-example]] -For example, the following snippet shows a -<> request that defines a watch that -looks for log error events: +For example, the following snippet shows a <> request that defines a watch that looks for log error events: [source,console] -------------------------------------------------- diff --git a/x-pack/docs/en/watcher/java/put-watch.asciidoc b/x-pack/docs/en/watcher/java/put-watch.asciidoc index 4958ddda4f04..e564e6ffdc4d 100644 --- a/x-pack/docs/en/watcher/java/put-watch.asciidoc +++ b/x-pack/docs/en/watcher/java/put-watch.asciidoc @@ -1,14 +1,14 @@ [discrete] [[api-java-put-watch]] -=== Put watch API +=== Create or update watch API -The put watch API either registers a new watch in {watcher} or update an -existing one. Once registered, a new document will be added to the `.watches` -index, representing the watch, and the watch trigger will immediately be -registered with the relevant trigger engine (typically the scheduler, for the +The create or update watch API either registers a new watch in {watcher} or +update an existing one. Once registered, a new document will be added to the +`.watches` index, representing the watch, and the watch trigger will immediately +be registered with the relevant trigger engine (typically the scheduler, for the `schedule` trigger). -IMPORTANT: Putting a watch must be done via this API only. Do not put a watch +IMPORTANT: Putting a watch must be done via this API only. Do not add a watch directly to the `.watches` index using Elasticsearch's Index API. When the {es} {security-features} are enabled, make sure no `write` privileges are granted to anyone over the `.watches` index. diff --git a/x-pack/docs/en/watcher/managing-watches.asciidoc b/x-pack/docs/en/watcher/managing-watches.asciidoc index 4b0b9f500a8b..f50e39888895 100644 --- a/x-pack/docs/en/watcher/managing-watches.asciidoc +++ b/x-pack/docs/en/watcher/managing-watches.asciidoc @@ -4,7 +4,7 @@ {watcher} provides as set of APIs you can use to manage your watches: -* Use the <> to add or update watches +* Use the <> to add or update watches * Use the <> to retrieve watches * Use the <> to delete watches * Use the <> to activate watches