Skip to content

Commit

Permalink
[DOCS] update autogenerated api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
polyfractal committed Nov 14, 2017
1 parent b824bb7 commit 7f2cd0b
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 3 deletions.
22 changes: 22 additions & 0 deletions docs/build/Elasticsearch/Namespaces/ClusterNamespace.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ The class defines the following methods:
* <<Elasticsearch_Namespaces_ClusterNamespacegetSettings_getSettings,`getSettings()`>>
* <<Elasticsearch_Namespaces_ClusterNamespacependingTasks_pendingTasks,`pendingTasks()`>>
* <<Elasticsearch_Namespaces_ClusterNamespaceallocationExplain_allocationExplain,`allocationExplain()`>>
* <<Elasticsearch_Namespaces_ClusterNamespaceremoteInfo_remoteInfo,`remoteInfo()`>>



Expand Down Expand Up @@ -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);
----
****


22 changes: 22 additions & 0 deletions docs/build/Elasticsearch/Namespaces/IngestNamespace.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The class defines the following methods:
* <<Elasticsearch_Namespaces_IngestNamespacegetPipeline_getPipeline,`getPipeline()`>>
* <<Elasticsearch_Namespaces_IngestNamespaceputPipeline_putPipeline,`putPipeline()`>>
* <<Elasticsearch_Namespaces_IngestNamespacesimulate_simulate,`simulate()`>>
* <<Elasticsearch_Namespaces_IngestNamespaceprocessorGrok_processorGrok,`processorGrok()`>>



Expand Down Expand Up @@ -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);
----
****


2 changes: 1 addition & 1 deletion docs/build/SAMI_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.0.4-DEV
4.0.10
2 changes: 1 addition & 1 deletion docs/build/renderer.index
Original file line number Diff line number Diff line change
@@ -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";}}}
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";}}}
2 changes: 1 addition & 1 deletion travis/generate_docs.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 7f2cd0b

Please sign in to comment.