From 7f2cd0b5e61b10c5e9c4b12c6e9baf70a87550a8 Mon Sep 17 00:00:00 2001 From: Zachary Tong Date: Tue, 14 Nov 2017 18:31:37 +0000 Subject: [PATCH] [DOCS] update autogenerated api docs --- .../Namespaces/ClusterNamespace.asciidoc | 22 +++++++++++++++++++ .../Namespaces/IngestNamespace.asciidoc | 22 +++++++++++++++++++ docs/build/SAMI_VERSION | 2 +- docs/build/renderer.index | 2 +- travis/generate_docs.sh | 2 +- 5 files changed, 47 insertions(+), 3 deletions(-) mode change 100644 => 100755 travis/generate_docs.sh diff --git a/docs/build/Elasticsearch/Namespaces/ClusterNamespace.asciidoc b/docs/build/Elasticsearch/Namespaces/ClusterNamespace.asciidoc index 562182c1a..d218581e7 100644 --- a/docs/build/Elasticsearch/Namespaces/ClusterNamespace.asciidoc +++ b/docs/build/Elasticsearch/Namespaces/ClusterNamespace.asciidoc @@ -20,6 +20,7 @@ The class defines the following methods: * <> * <> * <> +* <> @@ -208,3 +209,24 @@ $response = $client->cluster()->allocationExplain($params); **** + +[[Elasticsearch_Namespaces_ClusterNamespaceremoteInfo_remoteInfo]] +.`remoteInfo()` +**** +[source,php] +---- +/* +$params[] + ['body'] = (array) Request body +*/ + +$params = [ + // ... +]; + +$client = ClientBuilder::create()->build(); +$response = $client->cluster()->remoteInfo($params); +---- +**** + + diff --git a/docs/build/Elasticsearch/Namespaces/IngestNamespace.asciidoc b/docs/build/Elasticsearch/Namespaces/IngestNamespace.asciidoc index 7132c885e..7593d4ce6 100644 --- a/docs/build/Elasticsearch/Namespaces/IngestNamespace.asciidoc +++ b/docs/build/Elasticsearch/Namespaces/IngestNamespace.asciidoc @@ -16,6 +16,7 @@ The class defines the following methods: * <> * <> * <> +* <> @@ -104,3 +105,24 @@ $response = $client->ingest()->simulate($params); **** + +[[Elasticsearch_Namespaces_IngestNamespaceprocessorGrok_processorGrok]] +.`processorGrok()` +**** +[source,php] +---- +/* +$params[] + ['body'] = (array) Request body +*/ + +$params = [ + // ... +]; + +$client = ClientBuilder::create()->build(); +$response = $client->ingest()->processorGrok($params); +---- +**** + + diff --git a/docs/build/SAMI_VERSION b/docs/build/SAMI_VERSION index 5aef60798..4d5826d4b 100644 --- a/docs/build/SAMI_VERSION +++ b/docs/build/SAMI_VERSION @@ -1 +1 @@ -4.0.4-DEV \ No newline at end of file +4.0.10 \ No newline at end of file diff --git a/docs/build/renderer.index b/docs/build/renderer.index index 0854935d7..64af672be 100644 --- a/docs/build/renderer.index +++ b/docs/build/renderer.index @@ -1 +1 @@ -C:19:"Sami\Renderer\Index":1041:{a:3:{i:0;a:10:{s:20:"Elasticsearch\Client";s:40:"15e300130f53f99e789cf83e7acee62c4acb3b06";s:27:"Elasticsearch\ClientBuilder";s:40:"dd2f18513bbc502c54ee9ce217b5cd8e0ee702fd";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"a9d466909dc08564e9c1516162c3a6bb91dbecbe";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"0934f56b5dfa7978ab1907b6c8a04b0a293ae274";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"3d23245494af9443c215b31faa4e78dd6ab29750";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"b52adeb7071f16cba79cdcc3dac3fa6e53ed62bd";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"da4e71f9d953d00600920c26fe585b6884e45f94";s:40:"Elasticsearch\Namespaces\RemoteNamespace";s:40:"a503f6ea82452e1ea0275a044aeb527bc946616d";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"e28a1807789b0fcca3fd6b9712ed713650cf7ac2";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"2de86d7ab409a629320725f6444c76d2a9313c72";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}} \ No newline at end of file +C:19:"Sami\Renderer\Index":1041:{a:3:{i:0;a:10:{s:20:"Elasticsearch\Client";s:40:"6ac4061ad03df8cddeaec31a8bfb556fc7a33e71";s:27:"Elasticsearch\ClientBuilder";s:40:"30fa910e5653bf5f7096369ef1529a47da7e3e92";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"a9d466909dc08564e9c1516162c3a6bb91dbecbe";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"577bab662735319b93ed7b555cd2b12b73e40680";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"66391991c19f28764c86e9604e231b9ce004c82e";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"9bd2962d80e3c0cdcaedda4f23b722b3a8cfa013";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"da4e71f9d953d00600920c26fe585b6884e45f94";s:40:"Elasticsearch\Namespaces\RemoteNamespace";s:40:"a503f6ea82452e1ea0275a044aeb527bc946616d";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"e28a1807789b0fcca3fd6b9712ed713650cf7ac2";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"2de86d7ab409a629320725f6444c76d2a9313c72";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}} \ No newline at end of file diff --git a/travis/generate_docs.sh b/travis/generate_docs.sh old mode 100644 new mode 100755 index 6bbbd164c..88092120b --- a/travis/generate_docs.sh +++ b/travis/generate_docs.sh @@ -1,4 +1,4 @@ #!/usr/bin/env bash curl -O http://get.sensiolabs.org/sami.phar -php sami.phar update --force -v util/DocsConfig.php +php sami.phar update --force -v util/docsConfig.php