Merge pull request #924 from elastic/doc-examples

philkra · web-flow · commit 1a928390457b · 2019-08-02T20:16:34.000+02:00
Client examples in Docs
diff --git a/examples/048d8abd42d094bbdcf4452a58ccb35b.adoc b/examples/048d8abd42d094bbdcf4452a58ccb35b.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=048d8abd42d094bbdcf4452a58ccb35b]
+----
diff --git a/examples/0ba0b2db24852abccb7c0fc1098d566e.adoc b/examples/0ba0b2db24852abccb7c0fc1098d566e.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=0ba0b2db24852abccb7c0fc1098d566e]
+----
diff --git a/examples/0caf6b6b092ecbcf6f996053678a2384.adoc b/examples/0caf6b6b092ecbcf6f996053678a2384.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=0caf6b6b092ecbcf6f996053678a2384]
+----
diff --git a/examples/138ccd89f72aa7502dd9578403dcc589.adoc b/examples/138ccd89f72aa7502dd9578403dcc589.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=138ccd89f72aa7502dd9578403dcc589]
+----
diff --git a/examples/171d3a3af2d0f46cae5896c5bd3da4b5.adoc b/examples/171d3a3af2d0f46cae5896c5bd3da4b5.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=171d3a3af2d0f46cae5896c5bd3da4b5]
+----
diff --git a/examples/193864342d9f0a36ec84a91ca325f5ec.adoc b/examples/193864342d9f0a36ec84a91ca325f5ec.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=193864342d9f0a36ec84a91ca325f5ec]
+----
diff --git a/examples/1c0f3b0bc4b7e53b53755fd3bda5b8cf.adoc b/examples/1c0f3b0bc4b7e53b53755fd3bda5b8cf.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=1c0f3b0bc4b7e53b53755fd3bda5b8cf]
+----
diff --git a/examples/1d65cb6d055c46a1bde809687d835b71.adoc b/examples/1d65cb6d055c46a1bde809687d835b71.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=1d65cb6d055c46a1bde809687d835b71]
+----
diff --git a/examples/1f336ecc62480c1d56351cc2f82d0d08.adoc b/examples/1f336ecc62480c1d56351cc2f82d0d08.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=1f336ecc62480c1d56351cc2f82d0d08]
+----
diff --git a/examples/21fe98843fe0b5473f515d21803db409.adoc b/examples/21fe98843fe0b5473f515d21803db409.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=21fe98843fe0b5473f515d21803db409]
+----
diff --git a/examples/231aa0bb39c35fe199d28fe0e4a62b2e.adoc b/examples/231aa0bb39c35fe199d28fe0e4a62b2e.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=231aa0bb39c35fe199d28fe0e4a62b2e]
+----
diff --git a/examples/251ea12c1248385ab409906ac64d9ee9.adoc b/examples/251ea12c1248385ab409906ac64d9ee9.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=251ea12c1248385ab409906ac64d9ee9]
+----
diff --git a/examples/2de2349b7010652ca6104fb60f531a80.adoc b/examples/2de2349b7010652ca6104fb60f531a80.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=2de2349b7010652ca6104fb60f531a80]
+----
diff --git a/examples/2e6bfd38c9bcb728227f0d4dd11c09a2.adoc b/examples/2e6bfd38c9bcb728227f0d4dd11c09a2.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=2e6bfd38c9bcb728227f0d4dd11c09a2]
+----
diff --git a/examples/345ea7e9cb5af9e052ce0cf6f1f52c23.adoc b/examples/345ea7e9cb5af9e052ce0cf6f1f52c23.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=345ea7e9cb5af9e052ce0cf6f1f52c23]
+----
diff --git a/examples/36818c6d9f434d387819c30bd9addb14.adoc b/examples/36818c6d9f434d387819c30bd9addb14.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=36818c6d9f434d387819c30bd9addb14]
+----
diff --git a/examples/37a3b66b555aed55618254f50d572cd6.adoc b/examples/37a3b66b555aed55618254f50d572cd6.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=37a3b66b555aed55618254f50d572cd6]
+----
diff --git a/examples/37c778346eb67042df5e8edf2485e40a.adoc b/examples/37c778346eb67042df5e8edf2485e40a.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=37c778346eb67042df5e8edf2485e40a]
+----
diff --git a/examples/38dfa309717488362d0f784e17ebd1b5.adoc b/examples/38dfa309717488362d0f784e17ebd1b5.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=38dfa309717488362d0f784e17ebd1b5]
+----
diff --git a/examples/3c31f9eb032861bff64abd8b14758991.adoc b/examples/3c31f9eb032861bff64abd8b14758991.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=3c31f9eb032861bff64abd8b14758991]
+----
diff --git a/examples/3d7527bb7ac3b0e1f97b22bdfeb99070.adoc b/examples/3d7527bb7ac3b0e1f97b22bdfeb99070.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=3d7527bb7ac3b0e1f97b22bdfeb99070]
+----
diff --git a/examples/47b5ff897f26e9c943cee5c06034181d.adoc b/examples/47b5ff897f26e9c943cee5c06034181d.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/delete.php[tag=47b5ff897f26e9c943cee5c06034181d]
+----
diff --git a/examples/47bb632c6091ad0cd94bc660bdd309a5.adoc b/examples/47bb632c6091ad0cd94bc660bdd309a5.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=47bb632c6091ad0cd94bc660bdd309a5]
+----
diff --git a/examples/506844befdc5691d835771bcbb1c1a60.adoc b/examples/506844befdc5691d835771bcbb1c1a60.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=506844befdc5691d835771bcbb1c1a60]
+----
diff --git a/examples/5d38d4da86157b897e4876674bd169ef.adoc b/examples/5d38d4da86157b897e4876674bd169ef.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=5d38d4da86157b897e4876674bd169ef]
+----
diff --git a/examples/5eabcdbf61bfcb484dc694f25c2bba36.adoc b/examples/5eabcdbf61bfcb484dc694f25c2bba36.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=5eabcdbf61bfcb484dc694f25c2bba36]
+----
diff --git a/examples/625dc94df1f9affb49a082fd99d41620.adoc b/examples/625dc94df1f9affb49a082fd99d41620.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=625dc94df1f9affb49a082fd99d41620]
+----
diff --git a/examples/645796e8047967ca4a7635a22a876f4c.adoc b/examples/645796e8047967ca4a7635a22a876f4c.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=645796e8047967ca4a7635a22a876f4c]
+----
diff --git a/examples/69a7be47f85138b10437113ab2f0d72d.adoc b/examples/69a7be47f85138b10437113ab2f0d72d.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=69a7be47f85138b10437113ab2f0d72d]
+----
diff --git a/examples/6a8d7b34f2b42d5992aaa1ff147062d9.adoc b/examples/6a8d7b34f2b42d5992aaa1ff147062d9.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=6a8d7b34f2b42d5992aaa1ff147062d9]
+----
diff --git a/examples/710c7871f20f176d51209b1574b0d61b.adoc b/examples/710c7871f20f176d51209b1574b0d61b.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=710c7871f20f176d51209b1574b0d61b]
+----
diff --git a/examples/731621af937d66170347b9cc6b4a3c48.adoc b/examples/731621af937d66170347b9cc6b4a3c48.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=731621af937d66170347b9cc6b4a3c48]
+----
diff --git a/examples/745f9b8cdb8e91073f6e520e1d9f8c05.adoc b/examples/745f9b8cdb8e91073f6e520e1d9f8c05.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=745f9b8cdb8e91073f6e520e1d9f8c05]
+----
diff --git a/examples/75bda7da7fefff2c16f0423a9aa41c6e.adoc b/examples/75bda7da7fefff2c16f0423a9aa41c6e.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=75bda7da7fefff2c16f0423a9aa41c6e]
+----
diff --git a/examples/7d32a32357b5ea8819b72608fcc6fd07.adoc b/examples/7d32a32357b5ea8819b72608fcc6fd07.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=7d32a32357b5ea8819b72608fcc6fd07]
+----
diff --git a/examples/804a97ff4d0613e6568e4efb19c52021.adoc b/examples/804a97ff4d0613e6568e4efb19c52021.adoc
@@ -0,0 +1,12 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=804a97ff4d0613e6568e4efb19c52021]
+----
+
+<1> Permit only the auto-creation of indices called `twitter`, `index10`, no
+other index matching `index1*`, and any other index matching `ind*`. The
+patterns are matched in the order in which they are given.
+
+<2> Completely disable the auto-creation of indices.
+
+<3> Permit the auto-creation of indices with any name. This is the default.
diff --git a/examples/89a8ac1509936acc272fc2d72907bc45.adoc b/examples/89a8ac1509936acc272fc2d72907bc45.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=89a8ac1509936acc272fc2d72907bc45]
+----
diff --git a/examples/8fdf2344c4fb3de6902ad7c5735270df.adoc b/examples/8fdf2344c4fb3de6902ad7c5735270df.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=8fdf2344c4fb3de6902ad7c5735270df]
+----
diff --git a/examples/913770050ebbf3b9b549a899bc11060a.adoc b/examples/913770050ebbf3b9b549a899bc11060a.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=913770050ebbf3b9b549a899bc11060a]
+----
diff --git a/examples/92e3c75133dc4fdb2cc65f149001b40b.adoc b/examples/92e3c75133dc4fdb2cc65f149001b40b.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=92e3c75133dc4fdb2cc65f149001b40b]
+----
diff --git a/examples/98234499cfec70487cec5d013e976a84.adoc b/examples/98234499cfec70487cec5d013e976a84.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=98234499cfec70487cec5d013e976a84]
+----
diff --git a/examples/9c5ef83db886840355ff662b6e9ae8ab.adoc b/examples/9c5ef83db886840355ff662b6e9ae8ab.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=9c5ef83db886840355ff662b6e9ae8ab]
+----
diff --git a/examples/b8459547da50aebddbcdd1aaaac02b5f.adoc b/examples/b8459547da50aebddbcdd1aaaac02b5f.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=b8459547da50aebddbcdd1aaaac02b5f]
+----
diff --git a/examples/b8eab60f6441edf314306d8194c7cd56.adoc b/examples/b8eab60f6441edf314306d8194c7cd56.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=b8eab60f6441edf314306d8194c7cd56]
+----
diff --git a/examples/b918d6b798da673a33e49b94f61dcdc0.adoc b/examples/b918d6b798da673a33e49b94f61dcdc0.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=b918d6b798da673a33e49b94f61dcdc0]
+----
diff --git a/examples/bb143628fd04070683eeeadc9406d9cc.adoc b/examples/bb143628fd04070683eeeadc9406d9cc.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=bb143628fd04070683eeeadc9406d9cc]
+----
diff --git a/examples/c181969ef91c3b4a2513c1885be98e26.adoc b/examples/c181969ef91c3b4a2513c1885be98e26.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=c181969ef91c3b4a2513c1885be98e26]
+----
diff --git a/examples/c3fa04519df668d6c27727a12ab09648.adoc b/examples/c3fa04519df668d6c27727a12ab09648.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=c3fa04519df668d6c27727a12ab09648]
+----
diff --git a/examples/c5e5873783246c7b1c01d8464fed72c4.adoc b/examples/c5e5873783246c7b1c01d8464fed72c4.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/delete.php[tag=c5e5873783246c7b1c01d8464fed72c4]
+----
diff --git a/examples/c84b5f9c6528f84a08c5318b3385d55c.adoc b/examples/c84b5f9c6528f84a08c5318b3385d55c.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=c84b5f9c6528f84a08c5318b3385d55c]
+----
diff --git a/examples/cd247f267968aa0927bfdad56852f8f5.adoc b/examples/cd247f267968aa0927bfdad56852f8f5.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=cd247f267968aa0927bfdad56852f8f5]
+----
diff --git a/examples/cfbaea6f0df045c5d940bbb6a9c69cd8.adoc b/examples/cfbaea6f0df045c5d940bbb6a9c69cd8.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=cfbaea6f0df045c5d940bbb6a9c69cd8]
+----
diff --git a/examples/d718b63cf1b6591a1d59a0cf4fd995eb.adoc b/examples/d718b63cf1b6591a1d59a0cf4fd995eb.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/index_.php[tag=d718b63cf1b6591a1d59a0cf4fd995eb]
+----
diff --git a/examples/d90a84a24a407731dfc1929ac8327746.adoc b/examples/d90a84a24a407731dfc1929ac8327746.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/delete.php[tag=d90a84a24a407731dfc1929ac8327746]
+----
diff --git a/examples/db20adb70a8e8d0709d15ba0daf18d23.adoc b/examples/db20adb70a8e8d0709d15ba0daf18d23.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=db20adb70a8e8d0709d15ba0daf18d23]
+----
diff --git a/examples/e8035a7476601ad4b136edb250f92d53.adoc b/examples/e8035a7476601ad4b136edb250f92d53.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=e8035a7476601ad4b136edb250f92d53]
+----
diff --git a/examples/f8cc4b331a19ff4df8e4a490f906ee69.adoc b/examples/f8cc4b331a19ff4df8e4a490f906ee69.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=f8cc4b331a19ff4df8e4a490f906ee69]
+----
diff --git a/examples/fa5f618ced25ed2e67a1439bb77ba340.adoc b/examples/fa5f618ced25ed2e67a1439bb77ba340.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=fa5f618ced25ed2e67a1439bb77ba340]
+----
diff --git a/examples/fbcf5078a6a9e09790553804054c36b3.adoc b/examples/fbcf5078a6a9e09790553804054c36b3.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/docs/get.php[tag=fbcf5078a6a9e09790553804054c36b3]
+----
diff --git a/examples/feefeb68144002fd1fff57b77b95b85e.adoc b/examples/feefeb68144002fd1fff57b77b95b85e.adoc
@@ -0,0 +1,4 @@
+[source,php]
+----
+include::reference/getting-started.php[tag=feefeb68144002fd1fff57b77b95b85e]
+----
diff --git a/examples/reference/docs/delete.php b/examples/reference/docs/delete.php
@@ -0,0 +1,37 @@
+<?php
+/**
+ *
+ * @source docs/delete.asciidoc
+ *
+ * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
+ *
+ */
+
+// L:9
+// tag::c5e5873783246c7b1c01d8464fed72c4[]
+$params = [
+    'index' => 'twitter',
+    'id'    => '1',
+];
+$response = $client->delete($params);
+// end::c5e5873783246c7b1c01d8464fed72c4[]
+
+// L:84
+// tag::47b5ff897f26e9c943cee5c06034181d[]
+$params = [
+    'index'   => 'twitter',
+    'id'      => '1',
+    'routing' => 'kimchy',
+];
+$response = $client->delete($params);
+// end::47b5ff897f26e9c943cee5c06034181d[]
+
+// L:147
+// tag::d90a84a24a407731dfc1929ac8327746[]
+$params = [
+    'index'   => 'twitter',
+    'id'      => '1',
+    'timeout' => '5m',
+];
+$response = $client->delete($params);
+// end::d90a84a24a407731dfc1929ac8327746[]
diff --git a/examples/reference/docs/get.php b/examples/reference/docs/get.php
diff --git a/examples/reference/docs/index_.php b/examples/reference/docs/index_.php
diff --git a/examples/reference/getting-started.php b/examples/reference/getting-started.php
