Skip to content

Update whitelists and docs according with param renaming #857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update whitelists and docs according with param renaming #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/build/Elasticsearch/Client.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ $params['id'] = (string) The document ID (Required)
['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
['routing'] = (string) Specific routing value
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
['_source_include'] = (list) A list of fields to extract and return from the _source field
['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
['_source_includes'] = (list) A list of fields to extract and return from the _source field
['body'] = (array) Request body
*/

Expand Down Expand Up @@ -200,8 +200,8 @@ $response = $client->delete($params);
----
/*
$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
['_source_exclude'] = (array) A list of fields to exclude from the returned _source field
['_source_include'] = (array) A list of fields to extract and return from the _source field
['_source_excludes'] = (array) A list of fields to exclude from the returned _source field
['_source_includes'] = (array) A list of fields to extract and return from the _source field
['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)
['analyze_wildcard'] = (bool) Specify whether wildcard and prefix queries should be analyzed (default: false)
['analyzer'] = (string) The analyzer to use for the query string
Expand Down Expand Up @@ -665,8 +665,8 @@ $params['id'] = (string) The document ID (Required)
['routing'] = (string) Specific routing value
['source'] = (string) The URL-encoded query definition (instead of using the request body)
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
['_source_include'] = (list) A list of fields to extract and return from the _source field
['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
['_source_includes'] = (list) A list of fields to extract and return from the _source field
['body'] = (string) The URL-encoded query definition (instead of using the request body)
['body'] = (array) Request body
*/
Expand Down Expand Up @@ -712,8 +712,8 @@ $params['index'] = (list) A comma-separated list of index nam
['sort'] = (list) A comma-separated list of <field>:<direction> pairs
['source'] = (string) The URL-encoded request definition using the Query DSL (instead of using request body)
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
['_source_include'] = (list) A list of fields to extract and return from the _source field
['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
['_source_includes'] = (list) A list of fields to extract and return from the _source field
['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
['suggest_field'] = (string) Specify which field to use for suggestions
['suggest_mode'] = (enum) Specify suggest mode
Expand Down
24 changes: 12 additions & 12 deletions src/Elasticsearch/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,8 @@ public function ping($params = [])
* ['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
* ['routing'] = (string) Specific routing value
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
*
* @param array $params Associative array of parameters
*
Expand Down Expand Up @@ -270,8 +270,8 @@ public function delete($params)
/**
*
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* ['_source_exclude'] = (array) A list of fields to exclude from the returned _source field
* ['_source_include'] = (array) A list of fields to extract and return from the _source field
* ['_source_excludes'] = (array) A list of fields to exclude from the returned _source field
* ['_source_includes'] = (array) A list of fields to extract and return from the _source field
* ['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)
* ['analyze_wildcard'] = (bool) Specify whether wildcard and prefix queries should be analyzed (default: false)
* ['analyzer'] = (string) The analyzer to use for the query string
Expand Down Expand Up @@ -593,8 +593,8 @@ public function exists($params)
* ['routing'] = (string) Specific routing value
* ['body'] = (array) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
*
* @param array $params Associative array of parameters
*
Expand Down Expand Up @@ -865,8 +865,8 @@ public function suggest($params = array())
* ['routing'] = (string) Specific routing value
* ['source'] = (string) The URL-encoded query definition (instead of using the request body)
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
* ['body'] = (string) The URL-encoded query definition (instead of using the request body)
*
* @param array $params Associative array of parameters
Expand Down Expand Up @@ -919,8 +919,8 @@ public function explain($params)
* ['sort'] = (list) A comma-separated list of <field>:<direction> pairs
* ['source'] = (string) The URL-encoded request definition using the Query DSL (instead of using request body)
* ['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
* ['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
* ['suggest_field'] = (string) Specify which field to use for suggestions
* ['suggest_mode'] = (enum) Specify suggest mode
Expand Down Expand Up @@ -1151,8 +1151,8 @@ public function update($params)
* ['sort'] = (list) A comma-separated list of <field>:<direction> pairs
* ['_source'] = (list) True or false to return the _source field or not, or a list of
* fields to return
* ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
* ['_source_include'] = (list) A list of fields to extract and return from the _source field
* ['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* ['_source_includes'] = (list) A list of fields to extract and return from the _source field
* ['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon
* reaching which the query execution will terminate early.
* ['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/Bulk.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ public function getParamWhitelist()
'_source',
'_source_include',
'_source_exclude',
'_source_includes',
'_source_excludes',
'pipeline'
);
}
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/DeleteByQuery.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ public function getParamWhitelist()
'_source',
'_source_exclude',
'_source_include',
'_source_excludes',
'_source_includes',
'allow_no_indices',
'analyze_wildcard',
'analyzer',
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/Explain.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ public function getParamWhitelist()
'_source',
'_source_exclude',
'_source_include',
'_source_excludes',
'_source_includes',
'stored_fields'
);
}
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/Get.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ public function getParamWhitelist()
'_source',
'_source_exclude',
'_source_include',
'_source_excludes',
'_source_includes',
'version',
'version_type',
'stored_fields'
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/Mget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ public function getParamWhitelist()
'_source',
'_source_exclude',
'_source_include',
'_source_excludes',
'_source_includes',
'routing',
'stored_fields'
);
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/Search.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ public function getParamWhitelist()
'_source',
'_source_exclude',
'_source_include',
'_source_excludes',
'_source_includes',
'stats',
'suggest_field',
'suggest_mode',
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/Source/Get.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ public function getParamWhitelist()
'_source',
'_source_exclude',
'_source_include',
'_source_excludes',
'_source_includes',
'version',
'version_type',
);
Expand Down
2 changes: 2 additions & 0 deletions src/Elasticsearch/Endpoints/UpdateByQuery.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ public function getParamWhitelist()
'_source',
'_source_exclude',
'_source_include',
'_source_excludes',
'_source_includes',
'terminate_after',
'stats',
'suggest_field',
Expand Down