diff --git a/src/Endpoints/Indices.php b/src/Endpoints/Indices.php index d9e2d4c44..ae038ed6f 100644 --- a/src/Endpoints/Indices.php +++ b/src/Endpoints/Indices.php @@ -83,7 +83,7 @@ public function addBlock(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // Define analyzer/tokenizer parameters and the text on which the analysis should be performed + * body: array, // Define analyzer/tokenizer parameters and the text on which the analysis should be performed * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -174,7 +174,7 @@ public function clearCache(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The configuration for the target index (`settings` and `aliases`) + * body: array, // The configuration for the target index (`settings` and `aliases`) * } $params * * @throws MissingParameterException if a required parameter is missing @@ -259,7 +259,7 @@ public function close(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The configuration for the index (`settings` and `mappings`) + * body: array, // The configuration for the index (`settings` and `mappings`) * } $params * * @throws MissingParameterException if a required parameter is missing @@ -660,7 +660,7 @@ public function diskUsage(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The downsampling configuration + * body: array, // (REQUIRED) The downsampling configuration * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1484,7 +1484,7 @@ public function migrateToDataStream(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The data stream modifications + * body: array, // (REQUIRED) The data stream modifications * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1606,7 +1606,7 @@ public function promoteDataStream(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The settings for the alias, such as `routing` or `filter` + * body: array, // The settings for the alias, such as `routing` or `filter` * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1648,7 +1648,7 @@ public function putAlias(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The data stream lifecycle configuration that consist of the data retention + * body: array, // The data stream lifecycle configuration that consist of the data retention * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1690,7 +1690,7 @@ public function putDataLifecycle(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The template definition + * body: array, // (REQUIRED) The template definition * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1735,7 +1735,7 @@ public function putIndexTemplate(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The mapping definition + * body: array, // (REQUIRED) The mapping definition * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1782,7 +1782,7 @@ public function putMapping(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The index settings to be updated + * body: array, // (REQUIRED) The index settings to be updated * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1827,7 +1827,7 @@ public function putSettings(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The template definition + * body: array, // (REQUIRED) The template definition * } $params * * @throws MissingParameterException if a required parameter is missing @@ -2079,7 +2079,7 @@ public function resolveIndex(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The conditions that needs to be met for executing rollover + * body: array, // The conditions that needs to be met for executing rollover * } $params * * @throws MissingParameterException if a required parameter is missing @@ -2212,7 +2212,7 @@ public function shardStores(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The configuration for the target index (`settings` and `aliases`) + * body: array, // The configuration for the target index (`settings` and `aliases`) * } $params * * @throws MissingParameterException if a required parameter is missing @@ -2255,7 +2255,7 @@ public function shrink(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // New index template definition, which will be included in the simulation, as if it already exists in the system + * body: array, // New index template definition, which will be included in the simulation, as if it already exists in the system * } $params * * @throws MissingParameterException if a required parameter is missing @@ -2298,7 +2298,7 @@ public function simulateIndexTemplate(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // New index template definition to be simulated, if no index template name is specified + * body: array, // New index template definition to be simulated, if no index template name is specified * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -2343,7 +2343,7 @@ public function simulateTemplate(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The configuration for the target index (`settings` and `aliases`) + * body: array, // The configuration for the target index (`settings` and `aliases`) * } $params * * @throws MissingParameterException if a required parameter is missing @@ -2481,7 +2481,7 @@ public function unfreeze(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The definition of `actions` to perform + * body: array, // (REQUIRED) The definition of `actions` to perform * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -2531,7 +2531,7 @@ public function updateAliases(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The query definition specified with the Query DSL + * body: array, // The query definition specified with the Query DSL * } $params * * @throws NoNodeAvailableException if all the hosts are offline diff --git a/src/Traits/ClientEndpointsTrait.php b/src/Traits/ClientEndpointsTrait.php index 53f352ad0..b9c33a8b9 100644 --- a/src/Traits/ClientEndpointsTrait.php +++ b/src/Traits/ClientEndpointsTrait.php @@ -52,7 +52,7 @@ trait ClientEndpointsTrait * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The operation definition and data (action-data pairs), separated by newlines + * body: array, // (REQUIRED) The operation definition and data (action-data pairs), separated by newlines * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -94,7 +94,7 @@ public function bulk(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + * body: array, // A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -134,7 +134,7 @@ public function clearScroll(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // a point-in-time id to close + * body: array, // a point-in-time id to close * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -185,7 +185,7 @@ public function closePointInTime(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // A query to restrict the results specified with the Query DSL (optional) + * body: array, // A query to restrict the results specified with the Query DSL (optional) * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -236,7 +236,7 @@ public function count(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The document + * body: array, // (REQUIRED) The document * } $params * * @throws MissingParameterException if a required parameter is missing @@ -350,7 +350,7 @@ public function delete(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The search definition using the Query DSL + * body: array, // (REQUIRED) The search definition using the Query DSL * } $params * * @throws MissingParameterException if a required parameter is missing @@ -574,7 +574,7 @@ public function existsSource(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The query definition using the Query DSL + * body: array, // The query definition using the Query DSL * } $params * * @throws MissingParameterException if a required parameter is missing @@ -621,7 +621,7 @@ public function explain(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // An index filter specified with the Query DSL + * body: array, // An index filter specified with the Query DSL * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -919,7 +919,7 @@ public function healthReport(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The document + * body: array, // (REQUIRED) The document * } $params * * @throws MissingParameterException if a required parameter is missing @@ -998,7 +998,7 @@ public function info(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The search definition + * body: array, // The search definition * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1046,7 +1046,7 @@ public function knnSearch(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. + * body: array, // (REQUIRED) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1095,7 +1095,7 @@ public function mget(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The request definitions (metadata-search request definition pairs), separated by newlines + * body: array, // (REQUIRED) The request definitions (metadata-search request definition pairs), separated by newlines * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1142,7 +1142,7 @@ public function msearch(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The request definitions (metadata-search request definition pairs), separated by newlines + * body: array, // (REQUIRED) The request definitions (metadata-search request definition pairs), separated by newlines * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1196,7 +1196,7 @@ public function msearchTemplate(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. + * body: array, // Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1243,7 +1243,7 @@ public function mtermvectors(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // An index_filter specified with the Query DSL + * body: array, // An index_filter specified with the Query DSL * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1319,7 +1319,7 @@ public function ping(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The document + * body: array, // (REQUIRED) The document * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1366,7 +1366,7 @@ public function putScript(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. + * body: array, // (REQUIRED) The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1417,7 +1417,7 @@ public function rankEval(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The search definition using the Query DSL and the prototype for the index request. + * body: array, // (REQUIRED) The search definition using the Query DSL and the prototype for the index request. * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1493,7 +1493,7 @@ public function reindexRethrottle(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The search definition template and its params + * body: array, // The search definition template and its params * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1534,7 +1534,7 @@ public function renderSearchTemplate(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The script to execute + * body: array, // The script to execute * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1573,7 +1573,7 @@ public function scriptsPainlessExecute(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The scroll ID if not passed by URL or query parameter. + * body: array, // The scroll ID if not passed by URL or query parameter. * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1659,7 +1659,7 @@ public function scroll(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The search definition using the Query DSL + * body: array, // The search definition using the Query DSL * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1712,7 +1712,7 @@ public function search(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // Search request body. + * body: array, // Search request body. * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1810,7 +1810,7 @@ public function searchShards(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The search definition template and its params + * body: array, // (REQUIRED) The search definition template and its params * } $params * * @throws NoNodeAvailableException if all the hosts are offline @@ -1852,7 +1852,7 @@ public function searchTemplate(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // field name, string which is the prefix expected in matching terms, timeout and size for max number of results + * body: array, // field name, string which is the prefix expected in matching terms, timeout and size for max number of results * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1903,7 +1903,7 @@ public function termsEnum(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // Define parameters and or supply a document to get termvectors for. See documentation. + * body: array, // Define parameters and or supply a document to get termvectors for. See documentation. * } $params * * @throws MissingParameterException if a required parameter is missing @@ -1959,7 +1959,7 @@ public function termvectors(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // (REQUIRED) The request definition requires either `script` or partial `doc` + * body: array, // (REQUIRED) The request definition requires either `script` or partial `doc` * } $params * * @throws MissingParameterException if a required parameter is missing @@ -2030,7 +2030,7 @@ public function update(array $params = []) * error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false) * source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path: list, // A comma-separated list of filters used to reduce the response. - * body: array, // The search definition using the Query DSL + * body: array, // The search definition using the Query DSL * } $params * * @throws MissingParameterException if a required parameter is missing