[DOCS] Remove Sami from composer.json and update docs (#619)

* [DOCS] use Sami without having it in composer.json Thats what the docs suggest https://github.com/FriendsOfPHP/Sami > Installing Sami as a regular Composer dependency is NOT supported.
elastic · Aug 21, 2017 · fcd5ff1 · fcd5ff1
1 parent 23a0ba8
commit fcd5ff1
Show file tree

Hide file tree

Showing 12 changed files with 318 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
@@ -24,3 +24,6 @@ generator/*
 util/elasticsearch/
 util/cache/
 util/output
+
+# Sami docs generator
+/sami.phar
diff --git a/composer.json b/composer.json
@@ -21,7 +21,6 @@
     "symfony/yaml": "^2.8",
     "symfony/finder": "^2.8",
     "cpliakas/git-wrapper": "~1.0",
-    "sami/sami": "~3.2",
     "doctrine/inflector": "^1.1"
   },
   "suggest": {

diff --git a/docs/build/Elasticsearch/Client.asciidoc b/docs/build/Elasticsearch/Client.asciidoc
@@ -17,6 +17,7 @@ The class defines the following methods:
 * <<Elasticsearch_Clientget_get,`get()`>>
 * <<Elasticsearch_ClientgetSource_getSource,`getSource()`>>
 * <<Elasticsearch_Clientdelete_delete,`delete()`>>
+* <<Elasticsearch_ClientdeleteByQuery_deleteByQuery,`deleteByQuery()`>>
 * <<Elasticsearch_Clientcount_count,`count()`>>
 * <<Elasticsearch_ClientcountPercolate_countPercolate,`countPercolate()`>>
 * <<Elasticsearch_Clientpercolate_percolate,`percolate()`>>
@@ -26,6 +27,7 @@ The class defines the following methods:
 * <<Elasticsearch_Clientexists_exists,`exists()`>>
 * <<Elasticsearch_Clientmget_mget,`mget()`>>
 * <<Elasticsearch_Clientmsearch_msearch,`msearch()`>>
+* <<Elasticsearch_ClientmsearchTemplate_msearchTemplate,`msearchTemplate()`>>
 * <<Elasticsearch_Clientcreate_create,`create()`>>
 * <<Elasticsearch_Clientbulk_bulk,`bulk()`>>
 * <<Elasticsearch_Clientindex_index,`index()`>>
@@ -38,13 +40,15 @@ The class defines the following methods:
 * <<Elasticsearch_Clientscroll_scroll,`scroll()`>>
 * <<Elasticsearch_ClientclearScroll_clearScroll,`clearScroll()`>>
 * <<Elasticsearch_Clientupdate_update,`update()`>>
+* <<Elasticsearch_ClientupdateByQuery_updateByQuery,`updateByQuery()`>>
 * <<Elasticsearch_ClientgetScript_getScript,`getScript()`>>
 * <<Elasticsearch_ClientdeleteScript_deleteScript,`deleteScript()`>>
 * <<Elasticsearch_ClientputScript_putScript,`putScript()`>>
 * <<Elasticsearch_ClientgetTemplate_getTemplate,`getTemplate()`>>
 * <<Elasticsearch_ClientdeleteTemplate_deleteTemplate,`deleteTemplate()`>>
 * <<Elasticsearch_ClientputTemplate_putTemplate,`putTemplate()`>>
 * <<Elasticsearch_ClientfieldStats_fieldStats,`fieldStats()`>>
+* <<Elasticsearch_ClientfieldCaps_fieldCaps,`fieldCaps()`>>
 * <<Elasticsearch_ClientrenderSearchTemplate_renderSearchTemplate,`renderSearchTemplate()`>>
 * <<Elasticsearch_Clientindices_indices,`indices()`>>
 * <<Elasticsearch_Clientcluster_cluster,`cluster()`>>
@@ -53,6 +57,7 @@ The class defines the following methods:
 * <<Elasticsearch_Clientcat_cat,`cat()`>>
 * <<Elasticsearch_Clientingest_ingest,`ingest()`>>
 * <<Elasticsearch_Clienttasks_tasks,`tasks()`>>
+* <<Elasticsearch_Clientremote_remote,`remote()`>>
 * <<Elasticsearch_Client-call-_call,`__call()`>>
 * <<Elasticsearch_ClientextractArgument_extractArgument,`extractArgument()`>>
 
@@ -189,6 +194,36 @@ $response = $client->delete($params);
 
 
 
+[[Elasticsearch_ClientdeleteByQuery_deleteByQuery]]
+.`deleteByQuery()`
+****
+[source,php]
+----
+/*
+$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
+       ['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
+       ['conflicts'] = (enum) What to do when the delete-by-query hits version conflicts?
+       ['default_operator'] = (enum) The default operator for query string query (AND or OR)
+       ['df'] = (string) The field to use as default where no field prefix is given in the query string
+       ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
+       ['body']  = (array) Request body
+*/
+
+$params = [
+    // ...
+];
+
+$client = ClientBuilder::create()->build();
+$response = $client->deleteByQuery($params);
+----
+****
+
+
+
 [[Elasticsearch_Clientcount_count]]
 .`count()`
 ****
@@ -436,6 +471,31 @@ $response = $client->msearch($params);
 
 
 
+[[Elasticsearch_ClientmsearchTemplate_msearchTemplate]]
+.`msearchTemplate()`
+****
+[source,php]
+----
+/*
+$params['index']       = (list) A comma-separated list of index names to use as default
+       ['type']        = (list) A comma-separated list of document types to use as default
+       ['search_type'] = (enum) Search operation type
+       ['body']        = (array|string) The request definitions (metadata-search request definition pairs), separated by newlines
+       ['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
+       ['body']  = (array) Request body
+*/
+
+$params = [
+    // ...
+];
+
+$client = ClientBuilder::create()->build();
+$response = $client->msearchTemplate($params);
+----
+****
+
+
+
 [[Elasticsearch_Clientcreate_create]]
 .`create()`
 ****
@@ -661,8 +721,7 @@ $params['index']                    = (list) A comma-separated list of index nam
        ['suggest_size']             = (number) How many suggestions to return in response
        ['suggest_text']             = (text) The source text for which the suggestions should be returned
        ['timeout']                  = (time) Explicit operation timeout
-       ['version']                  = (boolean) Specify whether to return document version as part of a hit
-       ['body']                     = (array|string) The search definition using the Query DSL
+       ['terminate_after']          = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
        ['body']  = (array) Request body
 */
 
@@ -810,6 +869,62 @@ $response = $client->update($params);
 
 
 
+[[Elasticsearch_ClientupdateByQuery_updateByQuery]]
+.`updateByQuery()`
+****
+[source,php]
+----
+/*
+$params['index']                    = (list) A comma-separated list of index names to search; use `_all` or
+empty string to perform the operation on all indices (Required)
+       ['type']                     = (list) A comma-separated list of document types to search; leave empty to
+perform the operation on all types
+       ['analyzer']                 = (string) The analyzer to use for the query string
+       ['analyze_wildcard']         = (boolean) Specify whether wildcard and prefix queries should be analyzed
+(default: false)
+       ['default_operator']         = (enum) The default operator for query string query (AND or OR) (AND,OR)
+(default: OR)
+       ['df']                       = (string) The field to use as default where no field prefix is given in the
+query string
+       ['explain']                  = (boolean) Specify whether to return detailed information about score
+computation as part of a hit
+       ['fields']                   = (list) A comma-separated list of fields to return as part of a hit
+       ['fielddata_fields']         = (list) A comma-separated list of fields to return as the field data
+representation of a field for each hit
+       ['from']                     = (number) Starting offset (default: 0)
+       ['ignore_unavailable']       = (boolean) Whether specified concrete indices should be ignored when
+unavailable (missing or closed)
+       ['allow_no_indices']         = (boolean) Whether to ignore if a wildcard indices expression resolves into
+no concrete indices. (This includes `_all` string or when no indices have been specified)
+       ['conflicts']                = (enum) What to do when the reindex hits version conflicts? (abort,proceed)
+(default: abort)
+       ['expand_wildcards']         = (enum) Whether to expand wildcard expression to concrete indices that are
+open, closed or both. (open,closed,none,all) (default: open)
+       ['lenient']                  = (boolean) Specify whether format-based query failures (such as providing
+text to a numeric field) should be ignored
+       ['lowercase_expanded_terms'] = (boolean) Specify whether query terms should be lowercased
+       ['preference']               = (string) Specify the node or shard the operation should be performed on
+(default: random)
+       ['q']                        = (string) Query in the Lucene query string syntax
+       ['routing']                  = (list) A comma-separated list of specific routing values
+       ['scroll']                   = (duration) Specify how long a consistent view of the index should be
+maintained for scrolled search
+       ['search_type']              = (enum) Search operation type (query_then_fetch,dfs_query_then_fetch)
+       ['search_timeout']           = (time) Explicit timeout for each search request. Defaults to no timeout.
+       ['body']  = (array) Request body
+*/
+
+$params = [
+    // ...
+];
+
+$client = ClientBuilder::create()->build();
+$response = $client->updateByQuery($params);
+----
+****
+
+
+
 [[Elasticsearch_ClientgetScript_getScript]]
 .`getScript()`
 ****
@@ -965,6 +1080,30 @@ $response = $client->fieldStats($params);
 
 
 
+[[Elasticsearch_ClientfieldCaps_fieldCaps]]
+.`fieldCaps()`
+****
+[source,php]
+----
+/*
+$params['index']              = (list) A comma-separated list of indices to restrict the results
+       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
+       ['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)
+       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
+       ['body']  = (array) Request body
+*/
+
+$params = [
+    // ...
+];
+
+$client = ClientBuilder::create()->build();
+$response = $client->fieldCaps($params);
+----
+****
+
+
+
 [[Elasticsearch_ClientrenderSearchTemplate_renderSearchTemplate]]
 .`renderSearchTemplate()`
 ****
@@ -1133,6 +1272,27 @@ $response = $client->tasks();
 
 
 
+[[Elasticsearch_Clientremote_remote]]
+.`remote()`
+****
+[source,php]
+----
+/*
+Operate on the Remote namespace of commands
+       ['body']  = (array) Request body
+*/
+
+$params = [
+    // ...
+];
+
+$client = ClientBuilder::create()->build();
+$response = $client->remote();
+----
+****
+
+
+
 [[Elasticsearch_Client-call-_call]]
 .`__call()`
 ****

diff --git a/docs/build/Elasticsearch/ClientBuilder.asciidoc b/docs/build/Elasticsearch/ClientBuilder.asciidoc
@@ -13,6 +13,9 @@ Class ClientBuilder
 The class defines the following methods:
 
 * <<Elasticsearch_ClientBuildercreate_create,`create()`>>
+* <<Elasticsearch_ClientBuildergetTransport_getTransport,`getTransport()`>>
+* <<Elasticsearch_ClientBuildergetEndpoint_getEndpoint,`getEndpoint()`>>
+* <<Elasticsearch_ClientBuildergetRegisteredNamespacesBuilders_getRegisteredNamespacesBuilders,`getRegisteredNamespacesBuilders()`>>
 * <<Elasticsearch_ClientBuilderfromConfig_fromConfig,`fromConfig()`>>
 * <<Elasticsearch_ClientBuilderdefaultHandler_defaultHandler,`defaultHandler()`>>
 * <<Elasticsearch_ClientBuildermultiHandler_multiHandler,`multiHandler()`>>
@@ -28,13 +31,15 @@ The class defines the following methods:
 * <<Elasticsearch_ClientBuildersetTracer_setTracer,`setTracer()`>>
 * <<Elasticsearch_ClientBuildersetSerializer_setSerializer,`setSerializer()`>>
 * <<Elasticsearch_ClientBuildersetHosts_setHosts,`setHosts()`>>
+* <<Elasticsearch_ClientBuildersetConnectionParams_setConnectionParams,`setConnectionParams()`>>
 * <<Elasticsearch_ClientBuildersetRetries_setRetries,`setRetries()`>>
 * <<Elasticsearch_ClientBuildersetSelector_setSelector,`setSelector()`>>
 * <<Elasticsearch_ClientBuildersetSniffOnStart_setSniffOnStart,`setSniffOnStart()`>>
 * <<Elasticsearch_ClientBuildersetSSLCert_setSSLCert,`setSSLCert()`>>
 * <<Elasticsearch_ClientBuildersetSSLKey_setSSLKey,`setSSLKey()`>>
 * <<Elasticsearch_ClientBuildersetSSLVerification_setSSLVerification,`setSSLVerification()`>>
 * <<Elasticsearch_ClientBuilderbuild_build,`build()`>>
+* <<Elasticsearch_ClientBuilderinstantiate_instantiate,`instantiate()`>>
 
 
 
@@ -51,6 +56,51 @@ The class defines the following methods:
 
 
 
+[[Elasticsearch_ClientBuildergetTransport_getTransport]]
+.`getTransport()`
+****
+[source,php]
+----
+/*
+    Can supply first parm to Client::__construct() when invoking manually or with dependency injection
+    ['body']  = (array) Request body
+*/
+
+----
+****
+
+
+
+[[Elasticsearch_ClientBuildergetEndpoint_getEndpoint]]
+.`getEndpoint()`
+****
+[source,php]
+----
+/*
+    Can supply second parm to Client::__construct() when invoking manually or with dependency injection
+    ['body']  = (array) Request body
+*/
+
+----
+****
+
+
+
+[[Elasticsearch_ClientBuildergetRegisteredNamespacesBuilders_getRegisteredNamespacesBuilders]]
+.`getRegisteredNamespacesBuilders()`
+****
+[source,php]
+----
+/*
+    Can supply third parm to Client::__construct() when invoking manually or with dependency injection
+    ['body']  = (array) Request body
+*/
+
+----
+****
+
+
+
 [[Elasticsearch_ClientBuilderfromConfig_fromConfig]]
 .`fromConfig()`
 ****
@@ -250,6 +300,19 @@ corresponds to setConnectionPool().
 
 
 
+[[Elasticsearch_ClientBuildersetConnectionParams_setConnectionParams]]
+.`setConnectionParams()`
+****
+[source,php]
+----
+/*
+*/
+
+----
+****
+
+
+
 [[Elasticsearch_ClientBuildersetRetries_setRetries]]
 .`setRetries()`
 ****
@@ -340,3 +403,16 @@ corresponds to setConnectionPool().
 ****
 
 
+
+[[Elasticsearch_ClientBuilderinstantiate_instantiate]]
+.`instantiate()`
+****
+[source,php]
+----
+/*
+*/
+
+----
+****
+
+