Skip to content

Commit 694a08a

Browse files
committed
Fixed docs for 7.12
1 parent 93f050c commit 694a08a

36 files changed

+1820
-3026
lines changed

docs/build/Elasticsearch/Client.asciidoc

Lines changed: 304 additions & 525 deletions
Large diffs are not rendered by default.

docs/build/Elasticsearch/ClientBuilder.asciidoc

Lines changed: 109 additions & 39 deletions
Large diffs are not rendered by default.

docs/build/Elasticsearch/Namespaces/AsyncSearchNamespace.asciidoc

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11

2-
[discrete]
2+
33
[[Elasticsearch_Namespaces_AsyncSearchNamespace]]
44
=== Elasticsearch\Namespaces\AsyncSearchNamespace
55

66

77

88
Class AsyncSearchNamespace
9-
Generated running $ php util/GenerateEndpoints.php 7.9
9+
10+
*Description*
11+
12+
13+
NOTE: this file is autogenerated using util/GenerateEndpoints.php
14+
and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
1015

1116

1217
*Methods*
@@ -15,32 +20,30 @@ The class defines the following methods:
1520

1621
* <<Elasticsearch_Namespaces_AsyncSearchNamespacedelete_delete,`delete()`>>
1722
* <<Elasticsearch_Namespaces_AsyncSearchNamespaceget_get,`get()`>>
23+
* <<Elasticsearch_Namespaces_AsyncSearchNamespacestatus_status,`status()`>>
1824
* <<Elasticsearch_Namespaces_AsyncSearchNamespacesubmit_submit,`submit()`>>
1925

2026

2127

2228
[[Elasticsearch_Namespaces_AsyncSearchNamespacedelete_delete]]
2329
.`delete()`
30+
[[Elasticsearch_Namespaces_AsyncSearchNamespacedelete_delete]]
31+
.`delete(array $params = [])`
2432
****
2533
[source,php]
2634
----
2735
/*
2836
$params['id'] = (string) The async search ID
2937
*/
30-
31-
$params = [
32-
// ...
33-
];
34-
35-
$client = ClientBuilder::create()->build();
36-
$response = $client->asyncsearch()->delete($params);
3738
----
3839
****
3940

4041

4142

4243
[[Elasticsearch_Namespaces_AsyncSearchNamespaceget_get]]
4344
.`get()`
45+
[[Elasticsearch_Namespaces_AsyncSearchNamespaceget_get]]
46+
.`get(array $params = [])`
4447
****
4548
[source,php]
4649
----
@@ -50,20 +53,30 @@ $params['wait_for_completion_timeout'] = (time) Specify the time that the reques
5053
$params['keep_alive'] = (time) Specify the time interval in which the results (partial or final) for this search will be available
5154
$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
5255
*/
56+
----
57+
****
5358

54-
$params = [
55-
// ...
56-
];
5759

58-
$client = ClientBuilder::create()->build();
59-
$response = $client->asyncsearch()->get($params);
60+
61+
[[Elasticsearch_Namespaces_AsyncSearchNamespacestatus_status]]
62+
.`status()`
63+
[[Elasticsearch_Namespaces_AsyncSearchNamespacestatus_status]]
64+
.`status(array $params = [])`
65+
****
66+
[source,php]
67+
----
68+
/*
69+
$params['id'] = (string) The async search ID
70+
*/
6071
----
6172
****
6273

6374

6475

6576
[[Elasticsearch_Namespaces_AsyncSearchNamespacesubmit_submit]]
6677
.`submit()`
78+
[[Elasticsearch_Namespaces_AsyncSearchNamespacesubmit_submit]]
79+
.`submit(array $params = [])`
6780
****
6881
[source,php]
6982
----
@@ -98,13 +111,6 @@ $params['_source_excludes'] = (list) A list of fields to exclude fr
98111
$params['_source_includes'] = (list) A list of fields to extract and return from the _source field
99112
$params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
100113
*/
101-
102-
$params = [
103-
// ...
104-
];
105-
106-
$client = ClientBuilder::create()->build();
107-
$response = $client->asyncsearch()->submit($params);
108114
----
109115
****
110116

docs/build/Elasticsearch/Namespaces/AutoscalingNamespace.asciidoc

Lines changed: 18 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,85 @@
11

2-
[discrete]
2+
33
[[Elasticsearch_Namespaces_AutoscalingNamespace]]
44
=== Elasticsearch\Namespaces\AutoscalingNamespace
55

66

77

88
Class AutoscalingNamespace
9-
Generated running $ php util/GenerateEndpoints.php 7.9
9+
10+
*Description*
11+
12+
13+
NOTE: this file is autogenerated using util/GenerateEndpoints.php
14+
and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
1015

1116

1217
*Methods*
1318

1419
The class defines the following methods:
1520

1621
* <<Elasticsearch_Namespaces_AutoscalingNamespacedeleteAutoscalingPolicy_deleteAutoscalingPolicy,`deleteAutoscalingPolicy()`>>
17-
* <<Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingDecision_getAutoscalingDecision,`getAutoscalingDecision()`>>
22+
* <<Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingCapacity_getAutoscalingCapacity,`getAutoscalingCapacity()`>>
1823
* <<Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingPolicy_getAutoscalingPolicy,`getAutoscalingPolicy()`>>
1924
* <<Elasticsearch_Namespaces_AutoscalingNamespaceputAutoscalingPolicy_putAutoscalingPolicy,`putAutoscalingPolicy()`>>
2025

2126

2227

2328
[[Elasticsearch_Namespaces_AutoscalingNamespacedeleteAutoscalingPolicy_deleteAutoscalingPolicy]]
2429
.`deleteAutoscalingPolicy()`
25-
*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
30+
[[Elasticsearch_Namespaces_AutoscalingNamespacedeleteAutoscalingPolicy_deleteAutoscalingPolicy]]
31+
.`deleteAutoscalingPolicy(array $params = [])`
2632
****
2733
[source,php]
2834
----
2935
/*
3036
$params['name'] = (string) the name of the autoscaling policy
3137
*/
32-
33-
$params = [
34-
// ...
35-
];
36-
37-
$client = ClientBuilder::create()->build();
38-
$response = $client->autoscaling()->deleteAutoscalingPolicy($params);
3938
----
4039
****
4140

4241

4342

44-
[[Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingDecision_getAutoscalingDecision]]
45-
.`getAutoscalingDecision()`
43+
[[Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingCapacity_getAutoscalingCapacity]]
44+
.`getAutoscalingCapacity()`
45+
[[Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingCapacity_getAutoscalingCapacity]]
46+
.`getAutoscalingCapacity(array $params = [])`
4647
****
4748
[source,php]
4849
----
4950
/*
5051
*/
51-
52-
$params = [
53-
// ...
54-
];
55-
56-
$client = ClientBuilder::create()->build();
57-
$response = $client->autoscaling()->getAutoscalingDecision($params);
5852
----
5953
****
6054

6155

6256

6357
[[Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingPolicy_getAutoscalingPolicy]]
6458
.`getAutoscalingPolicy()`
65-
*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
59+
[[Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingPolicy_getAutoscalingPolicy]]
60+
.`getAutoscalingPolicy(array $params = [])`
6661
****
6762
[source,php]
6863
----
6964
/*
7065
$params['name'] = (string) the name of the autoscaling policy
7166
*/
72-
73-
$params = [
74-
// ...
75-
];
76-
77-
$client = ClientBuilder::create()->build();
78-
$response = $client->autoscaling()->getAutoscalingPolicy($params);
7967
----
8068
****
8169

8270

8371

8472
[[Elasticsearch_Namespaces_AutoscalingNamespaceputAutoscalingPolicy_putAutoscalingPolicy]]
8573
.`putAutoscalingPolicy()`
86-
*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
74+
[[Elasticsearch_Namespaces_AutoscalingNamespaceputAutoscalingPolicy_putAutoscalingPolicy]]
75+
.`putAutoscalingPolicy(array $params = [])`
8776
****
8877
[source,php]
8978
----
9079
/*
9180
$params['name'] = (string) the name of the autoscaling policy
9281
$params['body'] = (array) the specification of the autoscaling policy (Required)
9382
*/
94-
95-
$params = [
96-
// ...
97-
];
98-
99-
$client = ClientBuilder::create()->build();
100-
$response = $client->autoscaling()->putAutoscalingPolicy($params);
10183
----
10284
****
10385

0 commit comments

Comments
 (0)