diff --git a/docs/doc_examples/048d8abd42d094bbdcf4452a58ccb35b.asciidoc b/docs/doc_examples/048d8abd42d094bbdcf4452a58ccb35b.asciidoc new file mode 100644 index 000000000..42b87e0bc --- /dev/null +++ b/docs/doc_examples/048d8abd42d094bbdcf4452a58ccb35b.asciidoc @@ -0,0 +1,17 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.create({ + index: 'twitter', + id: '1', + body: { + user: 'kimchy', + post_date: '2009-11-15T14:12:12', + message: 'trying out Elasticsearch' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/0ba0b2db24852abccb7c0fc1098d566e.asciidoc b/docs/doc_examples/0ba0b2db24852abccb7c0fc1098d566e.asciidoc new file mode 100644 index 000000000..7e23f1bce --- /dev/null +++ b/docs/doc_examples/0ba0b2db24852abccb7c0fc1098d566e.asciidoc @@ -0,0 +1,19 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + id: '2', + routing: 'user1', + body: { + counter: 1, + tags: [ + 'white' + ] + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/0ce3606f1dba490eef83c4317b315b62.asciidoc b/docs/doc_examples/0ce3606f1dba490eef83c4317b315b62.asciidoc new file mode 100644 index 000000000..c89a1ffb3 --- /dev/null +++ b/docs/doc_examples/0ce3606f1dba490eef83c4317b315b62.asciidoc @@ -0,0 +1,18 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'twitter', + body: { + query: { + term: { + user: 'kimchy' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/138ccd89f72aa7502dd9578403dcc589.asciidoc b/docs/doc_examples/138ccd89f72aa7502dd9578403dcc589.asciidoc new file mode 100644 index 000000000..d6812ed4b --- /dev/null +++ b/docs/doc_examples/138ccd89f72aa7502dd9578403dcc589.asciidoc @@ -0,0 +1,13 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'twitter', + id: '0', + _source: 'false' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/1d65cb6d055c46a1bde809687d835b71.asciidoc b/docs/doc_examples/1d65cb6d055c46a1bde809687d835b71.asciidoc new file mode 100644 index 000000000..122c24c08 --- /dev/null +++ b/docs/doc_examples/1d65cb6d055c46a1bde809687d835b71.asciidoc @@ -0,0 +1,13 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'twitter', + id: '2', + routing: 'user1' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/1f336ecc62480c1d56351cc2f82d0d08.asciidoc b/docs/doc_examples/1f336ecc62480c1d56351cc2f82d0d08.asciidoc new file mode 100644 index 000000000..0de94149b --- /dev/null +++ b/docs/doc_examples/1f336ecc62480c1d56351cc2f82d0d08.asciidoc @@ -0,0 +1,17 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + id: '1', + version: '2', + version_type: 'external', + body: { + message: 'elasticsearch now has versioning support, double cool!' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/231aa0bb39c35fe199d28fe0e4a62b2e.asciidoc b/docs/doc_examples/231aa0bb39c35fe199d28fe0e4a62b2e.asciidoc new file mode 100644 index 000000000..ab3c92126 --- /dev/null +++ b/docs/doc_examples/231aa0bb39c35fe199d28fe0e4a62b2e.asciidoc @@ -0,0 +1,18 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + query: { + match_phrase: { + address: 'mill lane' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/2468ab381257d759d8a88af1141f6f9c.asciidoc b/docs/doc_examples/2468ab381257d759d8a88af1141f6f9c.asciidoc new file mode 100644 index 000000000..61aef030b --- /dev/null +++ b/docs/doc_examples/2468ab381257d759d8a88af1141f6f9c.asciidoc @@ -0,0 +1,12 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.existsSource({ + index: 'twitter', + id: '1' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/251ea12c1248385ab409906ac64d9ee9.asciidoc b/docs/doc_examples/251ea12c1248385ab409906ac64d9ee9.asciidoc new file mode 100644 index 000000000..839a8e655 --- /dev/null +++ b/docs/doc_examples/251ea12c1248385ab409906ac64d9ee9.asciidoc @@ -0,0 +1,28 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + query: { + bool: { + must: { + match_all: {} + }, + filter: { + range: { + balance: { + gte: 20000, + lte: 30000 + } + } + } + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/28aad2c5942bfb221c2bf1bbdc01658e.asciidoc b/docs/doc_examples/28aad2c5942bfb221c2bf1bbdc01658e.asciidoc new file mode 100644 index 000000000..5068af57e --- /dev/null +++ b/docs/doc_examples/28aad2c5942bfb221c2bf1bbdc01658e.asciidoc @@ -0,0 +1,20 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'city.*' + ], + query: 'this AND that OR thus' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/311c4b632a29b9ead63b02d01f10096b.asciidoc b/docs/doc_examples/311c4b632a29b9ead63b02d01f10096b.asciidoc new file mode 100644 index 000000000..cecf117ec --- /dev/null +++ b/docs/doc_examples/311c4b632a29b9ead63b02d01f10096b.asciidoc @@ -0,0 +1,15 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'customer', + id: '1', + body: { + name: 'John Doe' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/36818c6d9f434d387819c30bd9addb14.asciidoc b/docs/doc_examples/36818c6d9f434d387819c30bd9addb14.asciidoc new file mode 100644 index 000000000..5ee620974 --- /dev/null +++ b/docs/doc_examples/36818c6d9f434d387819c30bd9addb14.asciidoc @@ -0,0 +1,16 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + body: { + user: 'kimchy', + post_date: '2009-11-15T14:12:12', + message: 'trying out Elasticsearch' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/3d1ff6097e2359f927c88c2ccdb36252.asciidoc b/docs/doc_examples/3d1ff6097e2359f927c88c2ccdb36252.asciidoc new file mode 100644 index 000000000..d770d86e8 --- /dev/null +++ b/docs/doc_examples/3d1ff6097e2359f927c88c2ccdb36252.asciidoc @@ -0,0 +1,9 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.info() +console.log(response) +---- + diff --git a/docs/doc_examples/3f3b3e207f79303ce6f86e03e928e062.asciidoc b/docs/doc_examples/3f3b3e207f79303ce6f86e03e928e062.asciidoc new file mode 100644 index 000000000..828854a64 --- /dev/null +++ b/docs/doc_examples/3f3b3e207f79303ce6f86e03e928e062.asciidoc @@ -0,0 +1,12 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'customer', + id: '1' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/47b5ff897f26e9c943cee5c06034181d.asciidoc b/docs/doc_examples/47b5ff897f26e9c943cee5c06034181d.asciidoc new file mode 100644 index 000000000..d2a05c4fe --- /dev/null +++ b/docs/doc_examples/47b5ff897f26e9c943cee5c06034181d.asciidoc @@ -0,0 +1,13 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.delete({ + index: 'twitter', + id: '1', + routing: 'kimchy' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/47bb632c6091ad0cd94bc660bdd309a5.asciidoc b/docs/doc_examples/47bb632c6091ad0cd94bc660bdd309a5.asciidoc new file mode 100644 index 000000000..7f7456e59 --- /dev/null +++ b/docs/doc_examples/47bb632c6091ad0cd94bc660bdd309a5.asciidoc @@ -0,0 +1,31 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + query: { + bool: { + must: [ + { + match: { + age: '40' + } + } + ], + must_not: [ + { + match: { + state: 'ID' + } + } + ] + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/4b90feb9d5d3dbfce424dac0341320b7.asciidoc b/docs/doc_examples/4b90feb9d5d3dbfce424dac0341320b7.asciidoc new file mode 100644 index 000000000..74010bbda --- /dev/null +++ b/docs/doc_examples/4b90feb9d5d3dbfce424dac0341320b7.asciidoc @@ -0,0 +1,23 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + query: { + match_all: {} + }, + sort: [ + { + account_number: 'asc' + } + ], + from: 10, + size: 10 + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/506844befdc5691d835771bcbb1c1a60.asciidoc b/docs/doc_examples/506844befdc5691d835771bcbb1c1a60.asciidoc new file mode 100644 index 000000000..2c64f07b3 --- /dev/null +++ b/docs/doc_examples/506844befdc5691d835771bcbb1c1a60.asciidoc @@ -0,0 +1,21 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + query: { + match_all: {} + }, + sort: [ + { + account_number: 'asc' + } + ] + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/58b5003c0a53a39bf509aa3797aad471.asciidoc b/docs/doc_examples/58b5003c0a53a39bf509aa3797aad471.asciidoc new file mode 100644 index 000000000..259d93687 --- /dev/null +++ b/docs/doc_examples/58b5003c0a53a39bf509aa3797aad471.asciidoc @@ -0,0 +1,21 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'content', + 'name.*^5' + ], + query: 'this AND that OR thus' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/5eabcdbf61bfcb484dc694f25c2bba36.asciidoc b/docs/doc_examples/5eabcdbf61bfcb484dc694f25c2bba36.asciidoc new file mode 100644 index 000000000..cbd1a9889 --- /dev/null +++ b/docs/doc_examples/5eabcdbf61bfcb484dc694f25c2bba36.asciidoc @@ -0,0 +1,18 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + id: '1', + body: { + counter: 1, + tags: [ + 'red' + ] + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/609260ad1d5998be2ca09ff1fe237efa.asciidoc b/docs/doc_examples/609260ad1d5998be2ca09ff1fe237efa.asciidoc new file mode 100644 index 000000000..f3aa65766 --- /dev/null +++ b/docs/doc_examples/609260ad1d5998be2ca09ff1fe237efa.asciidoc @@ -0,0 +1,11 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.indices.getMapping({ + index: 'my-index' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/60ee33f3acfdd0fe6f288ac77312c780.asciidoc b/docs/doc_examples/60ee33f3acfdd0fe6f288ac77312c780.asciidoc new file mode 100644 index 000000000..0bb1ce32a --- /dev/null +++ b/docs/doc_examples/60ee33f3acfdd0fe6f288ac77312c780.asciidoc @@ -0,0 +1,21 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'title' + ], + query: 'this that thus', + minimum_should_match: 2 + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/625dc94df1f9affb49a082fd99d41620.asciidoc b/docs/doc_examples/625dc94df1f9affb49a082fd99d41620.asciidoc new file mode 100644 index 000000000..1e5878a4f --- /dev/null +++ b/docs/doc_examples/625dc94df1f9affb49a082fd99d41620.asciidoc @@ -0,0 +1,17 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + routing: 'kimchy', + body: { + user: 'kimchy', + post_date: '2009-11-15T14:12:12', + message: 'trying out Elasticsearch' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/645796e8047967ca4a7635a22a876f4c.asciidoc b/docs/doc_examples/645796e8047967ca4a7635a22a876f4c.asciidoc new file mode 100644 index 000000000..76b389764 --- /dev/null +++ b/docs/doc_examples/645796e8047967ca4a7635a22a876f4c.asciidoc @@ -0,0 +1,31 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + size: 0, + aggs: { + group_by_state: { + terms: { + field: 'state.keyword', + order: { + average_balance: 'desc' + } + }, + aggs: { + average_balance: { + avg: { + field: 'balance' + } + } + } + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/69a7be47f85138b10437113ab2f0d72d.asciidoc b/docs/doc_examples/69a7be47f85138b10437113ab2f0d72d.asciidoc new file mode 100644 index 000000000..c5f90d612 --- /dev/null +++ b/docs/doc_examples/69a7be47f85138b10437113ab2f0d72d.asciidoc @@ -0,0 +1,14 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'twitter', + id: '2', + routing: 'user1', + stored_fields: 'tags,counter' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/6f21a878fee3b43c5332b81aaddbeac7.asciidoc b/docs/doc_examples/6f21a878fee3b43c5332b81aaddbeac7.asciidoc new file mode 100644 index 000000000..08d4db379 --- /dev/null +++ b/docs/doc_examples/6f21a878fee3b43c5332b81aaddbeac7.asciidoc @@ -0,0 +1,23 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'title', + 'content' + ], + query: 'this OR that OR thus', + type: 'cross_fields', + minimum_should_match: 2 + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/710c7871f20f176d51209b1574b0d61b.asciidoc b/docs/doc_examples/710c7871f20f176d51209b1574b0d61b.asciidoc new file mode 100644 index 000000000..677e6bdfd --- /dev/null +++ b/docs/doc_examples/710c7871f20f176d51209b1574b0d61b.asciidoc @@ -0,0 +1,13 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'twitter', + id: '1', + stored_fields: 'tags,counter' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/71ba9033107882f61cdc3b32fc73568d.asciidoc b/docs/doc_examples/71ba9033107882f61cdc3b32fc73568d.asciidoc new file mode 100644 index 000000000..b2e8f8a5c --- /dev/null +++ b/docs/doc_examples/71ba9033107882f61cdc3b32fc73568d.asciidoc @@ -0,0 +1,19 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.indices.putMapping({ + index: 'my-index', + body: { + properties: { + 'employee-id': { + type: 'keyword', + index: false + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/745f9b8cdb8e91073f6e520e1d9f8c05.asciidoc b/docs/doc_examples/745f9b8cdb8e91073f6e520e1d9f8c05.asciidoc new file mode 100644 index 000000000..35ee07f1c --- /dev/null +++ b/docs/doc_examples/745f9b8cdb8e91073f6e520e1d9f8c05.asciidoc @@ -0,0 +1,13 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'twitter', + id: '0', + _source: '*.id,retweeted' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/804a97ff4d0613e6568e4efb19c52021.asciidoc b/docs/doc_examples/804a97ff4d0613e6568e4efb19c52021.asciidoc new file mode 100644 index 000000000..fed037571 --- /dev/null +++ b/docs/doc_examples/804a97ff4d0613e6568e4efb19c52021.asciidoc @@ -0,0 +1,33 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response0 = await client.cluster.putSettings({ + body: { + persistent: { + 'action.auto_create_index': 'twitter,index10,-index1*,+ind*' + } + } +}) +console.log(response0) + +const response1 = await client.cluster.putSettings({ + body: { + persistent: { + 'action.auto_create_index': 'false' + } + } +}) +console.log(response1) + +const response2 = await client.cluster.putSettings({ + body: { + persistent: { + 'action.auto_create_index': 'true' + } + } +}) +console.log(response2) +---- + diff --git a/docs/doc_examples/89a8ac1509936acc272fc2d72907bc45.asciidoc b/docs/doc_examples/89a8ac1509936acc272fc2d72907bc45.asciidoc new file mode 100644 index 000000000..f7af4f7b0 --- /dev/null +++ b/docs/doc_examples/89a8ac1509936acc272fc2d72907bc45.asciidoc @@ -0,0 +1,12 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.getSource({ + index: 'twitter', + id: '1' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/8fdf2344c4fb3de6902ad7c5735270df.asciidoc b/docs/doc_examples/8fdf2344c4fb3de6902ad7c5735270df.asciidoc new file mode 100644 index 000000000..6bb55708a --- /dev/null +++ b/docs/doc_examples/8fdf2344c4fb3de6902ad7c5735270df.asciidoc @@ -0,0 +1,14 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'twitter', + id: '0', + _source_includes: '*.id', + _source_excludes: 'entities' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/913770050ebbf3b9b549a899bc11060a.asciidoc b/docs/doc_examples/913770050ebbf3b9b549a899bc11060a.asciidoc new file mode 100644 index 000000000..464593801 --- /dev/null +++ b/docs/doc_examples/913770050ebbf3b9b549a899bc11060a.asciidoc @@ -0,0 +1,25 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.indices.create({ + index: 'twitter', + body: { + mappings: { + properties: { + counter: { + type: 'integer', + store: false + }, + tags: { + type: 'keyword', + store: true + } + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/98234499cfec70487cec5d013e976a84.asciidoc b/docs/doc_examples/98234499cfec70487cec5d013e976a84.asciidoc new file mode 100644 index 000000000..669ec3eb3 --- /dev/null +++ b/docs/doc_examples/98234499cfec70487cec5d013e976a84.asciidoc @@ -0,0 +1,12 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.exists({ + index: 'twitter', + id: '0' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/99a52be903945b17e734a1d02a57e958.asciidoc b/docs/doc_examples/99a52be903945b17e734a1d02a57e958.asciidoc new file mode 100644 index 000000000..0eae9d3c7 --- /dev/null +++ b/docs/doc_examples/99a52be903945b17e734a1d02a57e958.asciidoc @@ -0,0 +1,12 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.indices.getFieldMapping({ + index: 'my-index', + fields: 'employee-id' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/a2a25aad1fea9a541b52ac613c78fb64.asciidoc b/docs/doc_examples/a2a25aad1fea9a541b52ac613c78fb64.asciidoc new file mode 100644 index 000000000..af5b9dea4 --- /dev/null +++ b/docs/doc_examples/a2a25aad1fea9a541b52ac613c78fb64.asciidoc @@ -0,0 +1,22 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'content', + 'name^5' + ], + query: 'this AND that OR thus', + tie_breaker: 0 + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/ad6ea0c1e46712aa1fd6d3bfa0ec979e.asciidoc b/docs/doc_examples/ad6ea0c1e46712aa1fd6d3bfa0ec979e.asciidoc new file mode 100644 index 000000000..79e77abd8 --- /dev/null +++ b/docs/doc_examples/ad6ea0c1e46712aa1fd6d3bfa0ec979e.asciidoc @@ -0,0 +1,18 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + query: '(new york city) OR (big apple)', + default_field: 'content' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/b918d6b798da673a33e49b94f61dcdc0.asciidoc b/docs/doc_examples/b918d6b798da673a33e49b94f61dcdc0.asciidoc new file mode 100644 index 000000000..688866783 --- /dev/null +++ b/docs/doc_examples/b918d6b798da673a33e49b94f61dcdc0.asciidoc @@ -0,0 +1,18 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + id: '1', + timeout: '5m', + body: { + user: 'kimchy', + post_date: '2009-11-15T14:12:12', + message: 'trying out Elasticsearch' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/bb143628fd04070683eeeadc9406d9cc.asciidoc b/docs/doc_examples/bb143628fd04070683eeeadc9406d9cc.asciidoc new file mode 100644 index 000000000..04d174d4f --- /dev/null +++ b/docs/doc_examples/bb143628fd04070683eeeadc9406d9cc.asciidoc @@ -0,0 +1,17 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + id: '1', + body: { + user: 'kimchy', + post_date: '2009-11-15T14:12:12', + message: 'trying out Elasticsearch' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/be1bd47393646ac6bbee177d1cdb7738.asciidoc b/docs/doc_examples/be1bd47393646ac6bbee177d1cdb7738.asciidoc new file mode 100644 index 000000000..e6082026e --- /dev/null +++ b/docs/doc_examples/be1bd47393646ac6bbee177d1cdb7738.asciidoc @@ -0,0 +1,22 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'title', + 'content' + ], + query: 'this that thus', + minimum_should_match: 2 + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/bfcd65ab85d684d36a8550080032958d.asciidoc b/docs/doc_examples/bfcd65ab85d684d36a8550080032958d.asciidoc new file mode 100644 index 000000000..618f5153b --- /dev/null +++ b/docs/doc_examples/bfcd65ab85d684d36a8550080032958d.asciidoc @@ -0,0 +1,13 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + q: 'message:number', + size: '0', + terminate_after: '1' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/c5e5873783246c7b1c01d8464fed72c4.asciidoc b/docs/doc_examples/c5e5873783246c7b1c01d8464fed72c4.asciidoc new file mode 100644 index 000000000..2778add40 --- /dev/null +++ b/docs/doc_examples/c5e5873783246c7b1c01d8464fed72c4.asciidoc @@ -0,0 +1,12 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.delete({ + index: 'twitter', + id: '1' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/cd247f267968aa0927bfdad56852f8f5.asciidoc b/docs/doc_examples/cd247f267968aa0927bfdad56852f8f5.asciidoc new file mode 100644 index 000000000..a9e7678d6 --- /dev/null +++ b/docs/doc_examples/cd247f267968aa0927bfdad56852f8f5.asciidoc @@ -0,0 +1,18 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + query: { + match: { + address: 'mill lane' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/cfbaea6f0df045c5d940bbb6a9c69cd8.asciidoc b/docs/doc_examples/cfbaea6f0df045c5d940bbb6a9c69cd8.asciidoc new file mode 100644 index 000000000..e21d4bca8 --- /dev/null +++ b/docs/doc_examples/cfbaea6f0df045c5d940bbb6a9c69cd8.asciidoc @@ -0,0 +1,28 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + size: 0, + aggs: { + group_by_state: { + terms: { + field: 'state.keyword' + }, + aggs: { + average_balance: { + avg: { + field: 'balance' + } + } + } + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/d222c6a6ec7a3beca6c97011b0874512.asciidoc b/docs/doc_examples/d222c6a6ec7a3beca6c97011b0874512.asciidoc new file mode 100644 index 000000000..d5a16f507 --- /dev/null +++ b/docs/doc_examples/d222c6a6ec7a3beca6c97011b0874512.asciidoc @@ -0,0 +1,14 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.getSource({ + index: 'twitter', + id: '1', + _source_includes: '*.id', + _source_excludes: 'entities' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/d718b63cf1b6591a1d59a0cf4fd995eb.asciidoc b/docs/doc_examples/d718b63cf1b6591a1d59a0cf4fd995eb.asciidoc new file mode 100644 index 000000000..318bce61b --- /dev/null +++ b/docs/doc_examples/d718b63cf1b6591a1d59a0cf4fd995eb.asciidoc @@ -0,0 +1,18 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.index({ + index: 'twitter', + id: '1', + op_type: 'create', + body: { + user: 'kimchy', + post_date: '2009-11-15T14:12:12', + message: 'trying out Elasticsearch' + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/d8b2a88b5eca99d3691ad3cd40266736.asciidoc b/docs/doc_examples/d8b2a88b5eca99d3691ad3cd40266736.asciidoc new file mode 100644 index 000000000..3526a8624 --- /dev/null +++ b/docs/doc_examples/d8b2a88b5eca99d3691ad3cd40266736.asciidoc @@ -0,0 +1,26 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.indices.create({ + index: 'my-index', + body: { + mappings: { + properties: { + age: { + type: 'integer' + }, + email: { + type: 'keyword' + }, + name: { + type: 'text' + } + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/d90a84a24a407731dfc1929ac8327746.asciidoc b/docs/doc_examples/d90a84a24a407731dfc1929ac8327746.asciidoc new file mode 100644 index 000000000..35a5315ac --- /dev/null +++ b/docs/doc_examples/d90a84a24a407731dfc1929ac8327746.asciidoc @@ -0,0 +1,13 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.delete({ + index: 'twitter', + id: '1', + timeout: '5m' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/db6cba451ba562abe953d09ad80cc15c.asciidoc b/docs/doc_examples/db6cba451ba562abe953d09ad80cc15c.asciidoc new file mode 100644 index 000000000..364ce69b0 --- /dev/null +++ b/docs/doc_examples/db6cba451ba562abe953d09ad80cc15c.asciidoc @@ -0,0 +1,17 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + query: 'city.\\*:(this AND that OR thus)' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/e17e8852ec3f31781e1364f4dffeb6d0.asciidoc b/docs/doc_examples/e17e8852ec3f31781e1364f4dffeb6d0.asciidoc new file mode 100644 index 000000000..6d97c3961 --- /dev/null +++ b/docs/doc_examples/e17e8852ec3f31781e1364f4dffeb6d0.asciidoc @@ -0,0 +1,17 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + query: '(content:this OR name:this) AND (content:that OR name:that)' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/f2d68493abd3ca430bd03a7f7f8d18f9.asciidoc b/docs/doc_examples/f2d68493abd3ca430bd03a7f7f8d18f9.asciidoc new file mode 100644 index 000000000..f8bcb94ba --- /dev/null +++ b/docs/doc_examples/f2d68493abd3ca430bd03a7f7f8d18f9.asciidoc @@ -0,0 +1,21 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'content', + 'name' + ], + query: 'this AND that' + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/f32f0c19b42de3b87dd764fe4ca17e7c.asciidoc b/docs/doc_examples/f32f0c19b42de3b87dd764fe4ca17e7c.asciidoc new file mode 100644 index 000000000..d6baad2f7 --- /dev/null +++ b/docs/doc_examples/f32f0c19b42de3b87dd764fe4ca17e7c.asciidoc @@ -0,0 +1,19 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + default_field: 'title', + query: 'ny city', + auto_generate_synonyms_phrase_query: false + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/f8cc4b331a19ff4df8e4a490f906ee69.asciidoc b/docs/doc_examples/f8cc4b331a19ff4df8e4a490f906ee69.asciidoc new file mode 100644 index 000000000..747469daf --- /dev/null +++ b/docs/doc_examples/f8cc4b331a19ff4df8e4a490f906ee69.asciidoc @@ -0,0 +1,11 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.cat.health({ + v: '' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/fbcf5078a6a9e09790553804054c36b3.asciidoc b/docs/doc_examples/fbcf5078a6a9e09790553804054c36b3.asciidoc new file mode 100644 index 000000000..37c29d110 --- /dev/null +++ b/docs/doc_examples/fbcf5078a6a9e09790553804054c36b3.asciidoc @@ -0,0 +1,12 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.get({ + index: 'twitter', + id: '0' +}) +console.log(response) +---- + diff --git a/docs/doc_examples/fdd38f0d248385a444c777e7acd97846.asciidoc b/docs/doc_examples/fdd38f0d248385a444c777e7acd97846.asciidoc new file mode 100644 index 000000000..4b58cb9e3 --- /dev/null +++ b/docs/doc_examples/fdd38f0d248385a444c777e7acd97846.asciidoc @@ -0,0 +1,22 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + body: { + query: { + query_string: { + fields: [ + 'title', + 'content' + ], + query: 'this OR that OR thus', + minimum_should_match: 2 + } + } + } +}) +console.log(response) +---- + diff --git a/docs/doc_examples/feefeb68144002fd1fff57b77b95b85e.asciidoc b/docs/doc_examples/feefeb68144002fd1fff57b77b95b85e.asciidoc new file mode 100644 index 000000000..6c9393e31 --- /dev/null +++ b/docs/doc_examples/feefeb68144002fd1fff57b77b95b85e.asciidoc @@ -0,0 +1,21 @@ +// This file is autogenerated, DO NOT EDIT +// Use `node scripts/generate-docs-examples.js` to generate the docs examples + +[source, js] +---- +const response = await client.search({ + index: 'bank', + body: { + size: 0, + aggs: { + group_by_state: { + terms: { + field: 'state.keyword' + } + } + } + } +}) +console.log(response) +---- + diff --git a/scripts/generate-docs-examples.js b/scripts/generate-docs-examples.js new file mode 100644 index 000000000..54e99caa2 --- /dev/null +++ b/scripts/generate-docs-examples.js @@ -0,0 +1,96 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information + +'use strict' + +/** + * To run this generator you must have the + * `alternatives_report.spec.json` placed in the root of this project. + * To get the `alternatives_report.spec.json` you must run the script + * to parse the original `alternatives_report.json`, which is not yet public + * and lives in github.com/elastic/clients-team/tree/master/scripts/docs-json-generator + * + * This script will remove the content of the `docs/doc_examples` folder and generate + * all the files present in the `enabledFiles` list below. + * You can run it with the following command: + * + * ```bash + * $ node scripts/generate-docs-examples.js + * ``` + */ + +const { join } = require('path') +const { writeFileSync } = require('fs') +const rimraf = require('rimraf') +const standard = require('standard') +const dedent = require('dedent') + +const docsExamplesDir = join('docs', 'doc_examples') + +const enabledFiles = [ + 'docs/delete.asciidoc', + 'docs/get.asciidoc', + 'docs/index_.asciidoc', + 'getting-started.asciidoc', + 'query-dsl/query-string-query.asciidoc', + 'query-dsl.asciidoc', + 'search/request-body.asciidoc', + 'setup/install/check-running.asciidoc', + 'mapping.asciidoc' +] + +function generate () { + rimraf.sync(join(docsExamplesDir, '*')) + const examples = require(join(__dirname, '..', 'alternatives_report.spec.json')) + for (const example of examples) { + if (example.lang !== 'console') continue + if (!enabledFiles.includes(example.source_location.file)) continue + + const asciidoc = generateAsciidoc(example.parsed_source) + writeFileSync( + join(docsExamplesDir, `${example.digest}.asciidoc`), + asciidoc, + 'utf8' + ) + } +} + +function generateAsciidoc (source) { + var asciidoc = '// This file is autogenerated, DO NOT EDIT\n' + asciidoc += '// Use `node scripts/generate-docs-examples.js` to generate the docs examples\n\n' + var code = 'async function run (client) {\n// START\n' + + for (var i = 0; i < source.length; i++) { + const { api, query, params, body } = source[i] + const apiArguments = Object.assign({}, params, query, body ? { body } : body) + var serializedApiArguments = Object.keys(apiArguments).length > 0 + ? JSON.stringify(apiArguments, null, 2) + : '' + serializedApiArguments = serializedApiArguments.replace(/"/g, "'") + + code += `const response${getResponsePostfix(i)} = await client.${api.replace(/_([a-z])/g, g => g[1].toUpperCase())}(${serializedApiArguments}) +console.log(response${getResponsePostfix(i)}) +\n` + } + + code += '// END\n}' + const { results } = standard.lintTextSync(code, { fix: true }) + code = results[0].output + code = code.slice(code.indexOf('// START\n') + 9, code.indexOf('\n\n// END')) + + asciidoc += `[source, js] +---- +${dedent(code)} +---- + +` + return asciidoc + + function getResponsePostfix (i) { + if (source.length === 1) return '' + return String(i) + } +} + +generate()