Skip to content

Commit 302341a

Browse files
jrodewigdebadairlcawl
authored
[DOCS] Replace put with create or update in API names (#70330) (#70421)
Co-authored-by: debadair <[email protected]> Co-authored-by: Lisa Cawley <[email protected]>
1 parent 0a31d51 commit 302341a

File tree

81 files changed

+257
-296
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+257
-296
lines changed

docs/java-rest/high-level/ccr/put_follow.asciidoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,28 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put Follow API
8+
=== Create follower API
99

1010

1111
[id="{upid}-{api}-request"]
1212
==== Request
1313

14-
The Put Follow API allows creates a follower index and make that index follow a leader index.
14+
Creates a follower index and makes that index follow a leader index.
1515

1616
["source","java",subs="attributes,callouts,macros"]
1717
--------------------------------------------------
1818
include-tagged::{doc-tests-file}[{api}-request]
1919
--------------------------------------------------
2020
<1> The name of the remote cluster alias.
2121
<2> The name of the leader in the remote cluster.
22-
<3> The name of the follower index that gets created as part of the put follow API call.
23-
<4> The number of active shard copies to wait for before the put follow API returns a
24-
response, as an `ActiveShardCount`
22+
<3> The name of the follower index to create.
23+
<4> The number of shard copies that must be active before the call returns.
2524
<5> The settings overrides for the follower index.
2625

2726
[id="{upid}-{api}-response"]
2827
==== Response
2928

30-
The returned +{response}+ indicates if the put follow request was received.
29+
The +{response}+ indicates if the request was received.
3130

3231
["source","java",subs="attributes,callouts,macros"]
3332
--------------------------------------------------
@@ -38,5 +37,3 @@ include-tagged::{doc-tests-file}[{api}-response]
3837
<3> Whether the follower index started following the leader index.
3938

4039
include::../execution.asciidoc[]
41-
42-

docs/java-rest/high-level/cluster/put_component_template.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Put Component Template API
8+
=== Create or update component template API
99

10-
The Put Component Template API allows to create or change a component template.
10+
Creates or updates a component template.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Put Component Template Request
13+
==== Request
1414

1515
A +{request}+ specifies the name of the component template and the template definition,
1616
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]
5252
include::../execution.asciidoc[]
5353

5454
[id="{upid}-{api}-response"]
55-
==== Put Component Templates Response
55+
==== Response
5656

5757
The returned +{response}+ allows to retrieve information about the
5858
executed operation as follows:

docs/java-rest/high-level/enrich/put_policy.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Put Policy API
8+
=== Create or update enrich policy API
99

1010
[id="{upid}-{api}-request"]
1111
==== Request
1212

13-
The Put Policy API stores an enrich policy in Elasticsearch.
13+
Creates or updates an enrich policy.
1414

1515
["source","java",subs="attributes,callouts,macros"]
1616
--------------------------------------------------
@@ -20,12 +20,12 @@ include-tagged::{doc-tests-file}[{api}-request]
2020
[id="{upid}-{api}-response"]
2121
==== Response
2222

23-
The returned +{response}+ indicates if the put policy request was acknowledged.
23+
The +{response}+ indicates if the request was acknowledged.
2424

2525
["source","java",subs="attributes,callouts,macros"]
2626
--------------------------------------------------
2727
include-tagged::{doc-tests-file}[{api}-response]
2828
--------------------------------------------------
29-
<1> Whether put policy request was acknowledged.
29+
<1> Whether the request was acknowledged.
3030

3131
include::../execution.asciidoc[]

docs/java-rest/high-level/ilm/put_lifecycle_policy.asciidoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put Lifecycle Policy API
8+
=== Create or update lifecycle policy API
99

1010

1111
[id="{upid}-{api}-request"]
1212
==== Request
1313

14-
The Put Lifecycle Policy API allows you to add an Index Lifecycle Management
15-
Policy to the cluster.
14+
Creates or updates an index lifecycle management policy.
1615

1716
["source","java",subs="attributes,callouts,macros"]
1817
--------------------------------------------------
@@ -25,14 +24,13 @@ include-tagged::{doc-tests-file}[{api}-request]
2524
[id="{upid}-{api}-response"]
2625
==== Response
2726

28-
The returned +{response}+ indicates if the put lifecycle policy request was received.
27+
The +{response}+ indicates if the request was received.
2928

3029
["source","java",subs="attributes,callouts,macros"]
3130
--------------------------------------------------
3231
include-tagged::{doc-tests-file}[{api}-response]
3332
--------------------------------------------------
34-
<1> Whether or not the put lifecycle policy was acknowledged.
33+
<1> Whether or not the request was acknowledged.
3534

3635
include::../execution.asciidoc[]
3736

38-

docs/java-rest/high-level/ilm/put_snapshot_lifecycle_policy.asciidoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put Snapshot Lifecycle Policy API
8+
=== Create or update snapshot lifecycle policy API
99

1010

1111
[id="{upid}-{api}-request"]
1212
==== Request
1313

14-
The Put Snapshot Lifecycle Policy API allows you to add of update the definition of a Snapshot
15-
Lifecycle Management Policy in the cluster.
14+
Creates or updates a snapshot lifecycle management policy.
1615

1716
["source","java",subs="attributes,callouts,macros"]
1817
--------------------------------------------------
@@ -22,14 +21,13 @@ include-tagged::{doc-tests-file}[{api}-request]
2221
[id="{upid}-{api}-response"]
2322
==== Response
2423

25-
The returned +{response}+ indicates if the put snapshot lifecycle policy request was received.
24+
The +{response}+ indicates if the request was received.
2625

2726
["source","java",subs="attributes,callouts,macros"]
2827
--------------------------------------------------
2928
include-tagged::{doc-tests-file}[{api}-response]
3029
--------------------------------------------------
31-
<1> Whether or not the put snapshot lifecycle policy was acknowledged.
30+
<1> Whether or not the request was acknowledged.
3231

3332
include::../execution.asciidoc[]
3433

35-

docs/java-rest/high-level/indices/put_index_template.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Put Composable Index Template API
8+
=== Create or update composable index template API
99

1010
[id="{upid}-{api}-request"]
11-
==== Put Composable Index Template Request
11+
==== Request
1212

1313
A +{request}+ specifies the `name` of a template and the index template configuration
1414
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]
108108
include::../execution.asciidoc[]
109109

110110
[id="{upid}-{api}-response"]
111-
==== Put Composable Index Template Response
111+
==== Response
112112

113113
The returned +{response}+ allows to retrieve information about the
114114
executed operation as follows:

docs/java-rest/high-level/indices/put_mapping.asciidoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Put Mapping API
8+
=== Update mapping API
9+
10+
Adds new fields to an existing data stream or index. You can also use the API to
11+
change the search settings of existing fields.
912

1013
[id="{upid}-{api}-request"]
11-
==== Put Mapping Request
14+
==== Request
1215

1316
A +{request}+ requires an `index` argument:
1417

@@ -63,7 +66,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
6366
include::../execution.asciidoc[]
6467

6568
[id="{upid}-{api}-response"]
66-
==== Put Mapping Response
69+
==== Response
6770

6871
The returned +{response}+ allows to retrieve information about the executed
6972
operation as follows:

docs/java-rest/high-level/indices/put_template.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Put Template API
8+
=== Create or update index template API
99

1010
[id="{upid}-{api}-request"]
11-
==== Put Index Template Request
11+
==== Request
1212

1313
A +{request}+ specifies the `name` of a template and `patterns`
1414
which controls whether the template should be applied to the new index.
@@ -120,7 +120,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
120120
include::../execution.asciidoc[]
121121

122122
[id="{upid}-{api}-response"]
123-
==== Put Index Template Response
123+
==== Response
124124

125125
The returned +{response}+ allows to retrieve information about the
126126
executed operation as follows:

docs/java-rest/high-level/ingest/put_pipeline.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[[java-rest-high-ingest-put-pipeline]]
2-
=== Put Pipeline API
2+
=== Create or update pipeline API
33

44
[[java-rest-high-ingest-put-pipeline-request]]
5-
==== Put Pipeline Request
5+
==== Request
66

77
A `PutPipelineRequest` requires an `id` argument, a source and a `XContentType`. The source consists
88
of a description and a list of `Processor` objects.
@@ -44,9 +44,9 @@ include-tagged::{doc-tests}/IngestClientDocumentationIT.java[put-pipeline-execut
4444
[[java-rest-high-ingest-put-pipeline-async]]
4545
==== Asynchronous Execution
4646

47-
The asynchronous execution of a put pipeline request requires both the `PutPipelineRequest`
48-
instance and an `ActionListener` instance to be passed to the asynchronous
49-
method:
47+
The asynchronous execution of a create or update pipeline request requires both
48+
the `PutPipelineRequest` instance and an `ActionListener` instance to be passed
49+
to the asynchronous method:
5050

5151
["source","java",subs="attributes,callouts,macros"]
5252
--------------------------------------------------
@@ -71,7 +71,7 @@ provided as an argument
7171
<2> Called in case of failure. The raised exception is provided as an argument
7272

7373
[[java-rest-high-ingest-put-pipeline-response]]
74-
==== Put Pipeline Response
74+
==== Response
7575

7676
The returned `WritePipelineResponse` allows to retrieve information about the executed
7777
operation as follows:

docs/java-rest/high-level/ml/put-calendar-job.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put {anomaly-jobs} in calendar API
8+
=== Add {anomaly-jobs} to calendar API
99

1010
Adds {anomaly-jobs} jobs to an existing {ml} calendar.
1111
The API accepts a +{request}+ and responds
1212
with a +{response}+ object.
1313

1414
[id="{upid}-{api}-request"]
15-
==== Put {anomaly-jobs} in calendar request
15+
==== Request
1616

1717
A +{request}+ is constructed referencing a non-null
1818
calendar ID, and JobIDs to which to add to the calendar
@@ -25,7 +25,7 @@ include-tagged::{doc-tests-file}[{api}-request]
2525
<2> The JobIds to add to the calendar
2626

2727
[id="{upid}-{api}-response"]
28-
==== Put {anomaly-jobs} in calendar response
28+
==== Response
2929

3030
The returned +{response}+ contains the updated calendar:
3131

docs/java-rest/high-level/ml/put-calendar.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put calendars API
8+
=== Create calendars API
99

1010
Creates a new {ml} calendar.
1111
The API accepts a +{request}+ and responds
1212
with a +{response}+ object.
1313

1414
[id="{upid}-{api}-request"]
15-
==== Put calendars request
15+
==== Request
1616

1717
A +{request}+ is constructed with a calendar object
1818

@@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request]
2424

2525

2626
[id="{upid}-{api}-response"]
27-
==== Put calendars response
27+
==== Response
2828

2929
The returned +{response}+ contains the created calendar:
3030

docs/java-rest/high-level/ml/put-data-frame-analytics.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put {dfanalytics-jobs} API
8+
=== Create {dfanalytics-jobs} API
99

1010
beta::[]
1111

1212
Creates a new {dfanalytics-job}.
1313
The API accepts a +{request}+ object as a request and returns a +{response}+.
1414

1515
[id="{upid}-{api}-request"]
16-
==== Put {dfanalytics-jobs} request
16+
==== Request
1717

1818
A +{request}+ requires the following argument:
1919

docs/java-rest/high-level/ml/put-datafeed.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put datafeeds API
8+
=== Create datafeeds API
99

1010
Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object
1111
as a request and returns a +{response}+.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Put datafeeds request
14+
==== Request
1515

1616
A +{request}+ requires the following argument:
1717

docs/java-rest/high-level/ml/put-filter.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put filters API
8+
=== Create filters API
99

1010
Creates a new {ml} filter in the cluster. The API accepts a +{request}+ object
1111
as a request and returns a +{response}+.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Put filters request
14+
==== Request
1515

1616
A +{request}+ requires the following argument:
1717

docs/java-rest/high-level/ml/put-job.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put {anomaly-jobs} API
8+
=== Create {anomaly-jobs} API
99

1010
Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object
1111
as a request and returns a +{response}+.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Put {anomaly-jobs} request
14+
==== Request
1515

1616
A +{request}+ requires the following argument:
1717

0 commit comments

Comments
 (0)