[DOCS] Replace put with create or update in API names (#70330)

Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This commit is contained in:
James Rodewig 2021-03-15 14:49:44 -04:00 committed by GitHub
parent eee4fe2a86
commit 5c75d004fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
83 changed files with 296 additions and 333 deletions

View file

@ -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[]

View file

@ -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:

View file

@ -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[]

View file

@ -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[]

View file

@ -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[]

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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:

View file

@ -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

View file

@ -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