Added the alternatives_report.spec.json and applied the suggestions of #987

ezimuel · ezimuel · commit 4e802757845c · 2020-01-16T10:45:00.000+01:00
diff --git a/README.md b/README.md
@@ -54,6 +54,9 @@ Documentation
 --------------
 [Full documentation can be found here.](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html)  Docs are stored within the repo under /docs/, so if you see a typo or problem, please submit a PR to fix it!
 
+We also provide a code examples generator for PHP using the `util/GenerateDocExamples.php` script. This command parse the `util/alternative_report.spec.json` file produced from this [JSON specification](https://raw.githubusercontent.com/elastic/built-docs/master/raw/en/elasticsearch/reference/master/alternatives_report.json) and it generates the PHP examples foreach digest value.
+The examples are stored in asciidoc format under `docs/examples` folder.
+
 Installation via Composer
 -------------------------
 The recommended method to install _Elasticsearch-PHP_ is through [Composer](http://getcomposer.org).
diff --git a/docs/examples/028f6d6ac2594e20b78b8a8f8cbad49d.asciidoc b/docs/examples/028f6d6ac2594e20b78b8a8f8cbad49d.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:470
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/033778305d52746f5ce0a2a922c8e521.asciidoc b/docs/examples/033778305d52746f5ce0a2a922c8e521.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:544
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/048d8abd42d094bbdcf4452a58ccb35b.asciidoc b/docs/examples/048d8abd42d094bbdcf4452a58ccb35b.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:486
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/06afce2955f9094d96d27067ebca32e8.asciidoc b/docs/examples/06afce2955f9094d96d27067ebca32e8.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/bool-query.asciidoc:36
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/0ac9916f47a2483b89c1416684af322a.asciidoc b/docs/examples/0ac9916f47a2483b89c1416684af322a.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/match-query.asciidoc:241
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/0afaf1cad692e6201aa574c8feb6e622.asciidoc b/docs/examples/0afaf1cad692e6201aa574c8feb6e622.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:626
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/162b5b693b713f0bfab1209d59443c46.asciidoc b/docs/examples/162b5b693b713f0bfab1209d59443c46.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/bool-query.asciidoc:130
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/1c23507edd7a3c18538b68223378e4ab.asciidoc b/docs/examples/1c23507edd7a3c18538b68223378e4ab.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: indices/create-index.asciidoc:10
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/1f336ecc62480c1d56351cc2f82d0d08.asciidoc b/docs/examples/1f336ecc62480c1d56351cc2f82d0d08.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:395
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/34efeade38445b2834749ced59782e25.asciidoc b/docs/examples/34efeade38445b2834749ced59782e25.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:397
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/35e8da9410b8432cf4095f2541ad7b1d.asciidoc b/docs/examples/35e8da9410b8432cf4095f2541ad7b1d.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:264
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/36818c6d9f434d387819c30bd9addb14.asciidoc b/docs/examples/36818c6d9f434d387819c30bd9addb14.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:195
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/4466d410e06712c63328de4db249e6da.asciidoc b/docs/examples/4466d410e06712c63328de4db249e6da.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/range-query.asciidoc:152
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/4646764bf09911fee7d58630c72d3137.asciidoc b/docs/examples/4646764bf09911fee7d58630c72d3137.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:578
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/4d46dbb96125b27f46299547de9d8709.asciidoc b/docs/examples/4d46dbb96125b27f46299547de9d8709.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: indices/create-index.asciidoc:189
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/4d56b179242fed59e3d6476f817b6055.asciidoc b/docs/examples/4d56b179242fed59e3d6476f817b6055.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: indices/create-index.asciidoc:142
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/5043b83a89091fa00edb341ddf7ba370.asciidoc b/docs/examples/5043b83a89091fa00edb341ddf7ba370.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/match-query.asciidoc:219
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/527324766814561b75aaee853ede49a7.asciidoc b/docs/examples/527324766814561b75aaee853ede49a7.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:503
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/5d9d7b84e2fec7ecd832145cbb951cf1.asciidoc b/docs/examples/5d9d7b84e2fec7ecd832145cbb951cf1.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:683
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/6138d6919f3cbaaf61e1092f817d295c.asciidoc b/docs/examples/6138d6919f3cbaaf61e1092f817d295c.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/match-query.asciidoc:175
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/625dc94df1f9affb49a082fd99d41620.asciidoc b/docs/examples/625dc94df1f9affb49a082fd99d41620.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:244
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/6a4679531e64c492fce16dc12de6dcb0.asciidoc b/docs/examples/6a4679531e64c492fce16dc12de6dcb0.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:341
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/71b5b2ba9557d0f296ff2de91727d2f6.asciidoc b/docs/examples/71b5b2ba9557d0f296ff2de91727d2f6.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:377
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/774d715155cd13713e6e327adf6ce328.asciidoc b/docs/examples/774d715155cd13713e6e327adf6ce328.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:857
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/7f28f8ae8fcdbd807dadde0b5b007a6d.asciidoc b/docs/examples/7f28f8ae8fcdbd807dadde0b5b007a6d.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:775
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/7f56755fb6c42f7e6203339a6d0cb6e6.asciidoc b/docs/examples/7f56755fb6c42f7e6203339a6d0cb6e6.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/match-query.asciidoc:268
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/804a97ff4d0613e6568e4efb19c52021.asciidoc b/docs/examples/804a97ff4d0613e6568e4efb19c52021.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:146
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/92185a88554737bfa27b6bef09590c61.asciidoc b/docs/examples/92185a88554737bfa27b6bef09590c61.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/range-query.asciidoc:214
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/93f1bdd72e79827dcf9a34efa02fd977.asciidoc b/docs/examples/93f1bdd72e79827dcf9a34efa02fd977.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:358
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/97bcd92ef148312d41e69f0d18284327.asciidoc b/docs/examples/97bcd92ef148312d41e69f0d18284327.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/range-query.asciidoc:16
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/98b121bf47cebd85671a2cb519688d28.asciidoc b/docs/examples/98b121bf47cebd85671a2cb519688d28.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:654
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/9a8995fd31351045d99c78e40444c8ea.asciidoc b/docs/examples/9a8995fd31351045d99c78e40444c8ea.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:57
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/a49169b4622918992411fab4ec48191b.asciidoc b/docs/examples/a49169b4622918992411fab4ec48191b.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:600
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/b918d6b798da673a33e49b94f61dcdc0.asciidoc b/docs/examples/b918d6b798da673a33e49b94f61dcdc0.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:366
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/b9c5d7ca6ca9c6f747201f45337a4abf.asciidoc b/docs/examples/b9c5d7ca6ca9c6f747201f45337a4abf.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: indices/create-index.asciidoc:98
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/bb143628fd04070683eeeadc9406d9cc.asciidoc b/docs/examples/bb143628fd04070683eeeadc9406d9cc.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:453
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/cd5bc5bf7cd58d7b1492c9c298b345f6.asciidoc b/docs/examples/cd5bc5bf7cd58d7b1492c9c298b345f6.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:806
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/d50a3835bf5795ac73e58906a3413544.asciidoc b/docs/examples/d50a3835bf5795ac73e58906a3413544.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:135
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/d718b63cf1b6591a1d59a0cf4fd995eb.asciidoc b/docs/examples/d718b63cf1b6591a1d59a0cf4fd995eb.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: docs/index_.asciidoc:499
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/dc15e2373e5ecbe09b4ea0858eb63d47.asciidoc b/docs/examples/dc15e2373e5ecbe09b4ea0858eb63d47.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: aggregations/bucket/terms-aggregation.asciidoc:443
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/dfef545b1e2c247bafd1347e8e807ac1.asciidoc b/docs/examples/dfef545b1e2c247bafd1347e8e807ac1.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: indices/create-index.asciidoc:122
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/e0d6e02b998bdea99c9c08dcc3630c5e.asciidoc b/docs/examples/e0d6e02b998bdea99c9c08dcc3630c5e.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: query-dsl/match-query.asciidoc:18
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/e5d2172b524332196cac0f031c043659.asciidoc b/docs/examples/e5d2172b524332196cac0f031c043659.asciidoc
@@ -1,6 +1,5 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `php util/GenerateDocExamples.php` to generate the docs examples
-    
+// Autogenerated from source: indices/create-index.asciidoc:80
+
 [source, php]
 ----
 $params = [
diff --git a/docs/examples/f085fb032dae56a3b104ab874eaea2ad.asciidoc b/docs/examples/f085fb032dae56a3b104ab874eaea2ad.asciidoc
diff --git a/docs/examples/f29a28fffa7ec604a33a838f48f7ea79.asciidoc b/docs/examples/f29a28fffa7ec604a33a838f48f7ea79.asciidoc
diff --git a/docs/examples/f70a54cd9a9f4811bf962e469f2ca2ea.asciidoc b/docs/examples/f70a54cd9a9f4811bf962e469f2ca2ea.asciidoc
diff --git a/docs/examples/fa2fe60f570bd930d2891778c6efbfe6.asciidoc b/docs/examples/fa2fe60f570bd930d2891778c6efbfe6.asciidoc
diff --git a/docs/examples/fa88f6f5a7d728ec4f1d05244228cb09.asciidoc b/docs/examples/fa88f6f5a7d728ec4f1d05244228cb09.asciidoc
diff --git a/docs/examples/fabe14480624a99e8ee42c7338672058.asciidoc b/docs/examples/fabe14480624a99e8ee42c7338672058.asciidoc
diff --git a/util/GenerateDocExamples.php b/util/GenerateDocExamples.php
diff --git a/util/alternatives_report.spec.json b/util/alternatives_report.spec.json
