Skip to content

Commit a7c22c2

Browse files
author
Yury Kaminskii
committed
Update whitelists and docs according with param renaming
1 parent e91a436 commit a7c22c2

File tree

10 files changed

+36
-20
lines changed

10 files changed

+36
-20
lines changed

docs/build/Elasticsearch/Client.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ $params['id'] = (string) The document ID (Required)
118118
['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
119119
['routing'] = (string) Specific routing value
120120
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
121-
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
122-
['_source_include'] = (list) A list of fields to extract and return from the _source field
121+
['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
122+
['_source_includes'] = (list) A list of fields to extract and return from the _source field
123123
['body'] = (array) Request body
124124
*/
125125
@@ -200,8 +200,8 @@ $response = $client->delete($params);
200200
----
201201
/*
202202
$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
203-
['_source_exclude'] = (array) A list of fields to exclude from the returned _source field
204-
['_source_include'] = (array) A list of fields to extract and return from the _source field
203+
['_source_excludes'] = (array) A list of fields to exclude from the returned _source field
204+
['_source_includes'] = (array) A list of fields to extract and return from the _source field
205205
['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
206206
['analyze_wildcard'] = (bool) Specify whether wildcard and prefix queries should be analyzed (default: false)
207207
['analyzer'] = (string) The analyzer to use for the query string
@@ -665,8 +665,8 @@ $params['id'] = (string) The document ID (Required)
665665
['routing'] = (string) Specific routing value
666666
['source'] = (string) The URL-encoded query definition (instead of using the request body)
667667
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
668-
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
669-
['_source_include'] = (list) A list of fields to extract and return from the _source field
668+
['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
669+
['_source_includes'] = (list) A list of fields to extract and return from the _source field
670670
['body'] = (string) The URL-encoded query definition (instead of using the request body)
671671
['body'] = (array) Request body
672672
*/
@@ -712,8 +712,8 @@ $params['index'] = (list) A comma-separated list of index nam
712712
['sort'] = (list) A comma-separated list of <field>:<direction> pairs
713713
['source'] = (string) The URL-encoded request definition using the Query DSL (instead of using request body)
714714
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
715-
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
716-
['_source_include'] = (list) A list of fields to extract and return from the _source field
715+
['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
716+
['_source_includes'] = (list) A list of fields to extract and return from the _source field
717717
['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
718718
['suggest_field'] = (string) Specify which field to use for suggestions
719719
['suggest_mode'] = (enum) Specify suggest mode

src/Elasticsearch/Client.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ public function ping($params = [])
167167
* ['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
168168
* ['routing'] = (string) Specific routing value
169169
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
170-
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
171-
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
170+
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
171+
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
172172
*
173173
* @param array $params Associative array of parameters
174174
*
@@ -270,8 +270,8 @@ public function delete($params)
270270
/**
271271
*
272272
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
273-
* ['_source_exclude'] = (array) A list of fields to exclude from the returned _source field
274-
* ['_source_include'] = (array) A list of fields to extract and return from the _source field
273+
* ['_source_excludes'] = (array) A list of fields to exclude from the returned _source field
274+
* ['_source_includes'] = (array) A list of fields to extract and return from the _source field
275275
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
276276
* ['analyze_wildcard'] = (bool) Specify whether wildcard and prefix queries should be analyzed (default: false)
277277
* ['analyzer'] = (string) The analyzer to use for the query string
@@ -593,8 +593,8 @@ public function exists($params)
593593
* ['routing'] = (string) Specific routing value
594594
* ['body'] = (array) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.
595595
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
596-
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
597-
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
596+
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
597+
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
598598
*
599599
* @param array $params Associative array of parameters
600600
*
@@ -865,8 +865,8 @@ public function suggest($params = array())
865865
* ['routing'] = (string) Specific routing value
866866
* ['source'] = (string) The URL-encoded query definition (instead of using the request body)
867867
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
868-
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
869-
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
868+
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
869+
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
870870
* ['body'] = (string) The URL-encoded query definition (instead of using the request body)
871871
*
872872
* @param array $params Associative array of parameters
@@ -919,8 +919,8 @@ public function explain($params)
919919
* ['sort'] = (list) A comma-separated list of <field>:<direction> pairs
920920
* ['source'] = (string) The URL-encoded request definition using the Query DSL (instead of using request body)
921921
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
922-
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
923-
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
922+
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
923+
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
924924
* ['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
925925
* ['suggest_field'] = (string) Specify which field to use for suggestions
926926
* ['suggest_mode'] = (enum) Specify suggest mode
@@ -1151,8 +1151,8 @@ public function update($params)
11511151
* ['sort'] = (list) A comma-separated list of <field>:<direction> pairs
11521152
* ['_source'] = (list) True or false to return the _source field or not, or a list of
11531153
* fields to return
1154-
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
1155-
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
1154+
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
1155+
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
11561156
* ['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon
11571157
* reaching which the query execution will terminate early.
11581158
* ['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes

src/Elasticsearch/Endpoints/Bulk.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ public function getParamWhitelist()
7676
'_source',
7777
'_source_include',
7878
'_source_exclude',
79+
'_source_includes',
80+
'_source_excludes',
7981
'pipeline'
8082
);
8183
}

src/Elasticsearch/Endpoints/DeleteByQuery.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ public function getParamWhitelist()
6363
'_source',
6464
'_source_exclude',
6565
'_source_include',
66+
'_source_excludes',
67+
'_source_includes',
6668
'allow_no_indices',
6769
'analyze_wildcard',
6870
'analyzer',

src/Elasticsearch/Endpoints/Explain.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ public function getParamWhitelist()
8888
'_source',
8989
'_source_exclude',
9090
'_source_include',
91+
'_source_excludes',
92+
'_source_includes',
9193
'stored_fields'
9294
);
9395
}

src/Elasticsearch/Endpoints/Get.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ public function getParamWhitelist()
9595
'_source',
9696
'_source_exclude',
9797
'_source_include',
98+
'_source_excludes',
99+
'_source_includes',
98100
'version',
99101
'version_type',
100102
'stored_fields'

src/Elasticsearch/Endpoints/Mget.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ public function getParamWhitelist()
6767
'_source',
6868
'_source_exclude',
6969
'_source_include',
70+
'_source_excludes',
71+
'_source_includes',
7072
'routing',
7173
'stored_fields'
7274
);

src/Elasticsearch/Endpoints/Search.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ public function getParamWhitelist()
8787
'_source',
8888
'_source_exclude',
8989
'_source_include',
90+
'_source_excludes',
91+
'_source_includes',
9092
'stats',
9193
'suggest_field',
9294
'suggest_mode',

src/Elasticsearch/Endpoints/Source/Get.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ public function getParamWhitelist()
6565
'_source',
6666
'_source_exclude',
6767
'_source_include',
68+
'_source_excludes',
69+
'_source_includes',
6870
'version',
6971
'version_type',
7072
);

src/Elasticsearch/Endpoints/UpdateByQuery.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ public function getParamWhitelist()
9292
'_source',
9393
'_source_exclude',
9494
'_source_include',
95+
'_source_excludes',
96+
'_source_includes',
9597
'terminate_after',
9698
'stats',
9799
'suggest_field',

0 commit comments

Comments
 (0)