Update docs examples (#1081)

* Updated enabled files list

* Generated docs examples

* Generated docs examples
This commit is contained in:
Tomas Della Vedova
2020-02-06 12:04:29 +01:00
committed by GitHub
parent 41927914bb
commit 28205e97cf
46 changed files with 928 additions and 3 deletions

View File

@ -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: {
multi_match: {
query: 'Will Smith',
type: 'cross_fields',
fields: [
'first_name',
'last_name'
],
operator: 'and'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,24 @@
// 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.index({
index: 'users',
refresh: 'wait_for',
body: {
user_id: 12345
}
})
console.log(response0)
const response1 = await client.index({
index: 'users',
refresh: 'wait_for',
body: {
user_id: 12346
}
})
console.log(response1)
----

View File

@ -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.indices.putMapping({
index: 'my_index',
body: {
properties: {
name: {
properties: {
last: {
type: 'text'
}
}
}
}
}
})
console.log(response)
----

View File

@ -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: {
multi_match: {
query: 'quick brown f',
type: 'phrase_prefix',
fields: [
'subject',
'message'
]
}
}
}
})
console.log(response)
----

View File

@ -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.create({
index: 'publications'
})
console.log(response)
----

View File

@ -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.search({
q: 'user:kimchy'
})
console.log(response)
----

View File

@ -0,0 +1,24 @@
// 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: {
multi_match: {
query: 'Jon',
type: 'cross_fields',
analyzer: 'standard',
fields: [
'first',
'last',
'*.edge'
]
}
}
}
})
console.log(response)
----

View File

@ -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: {
user_id: {
type: 'keyword',
ignore_above: 100
}
}
}
})
console.log(response)
----

View File

@ -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 response0 = await client.indices.create({
index: 'twitter-1'
})
console.log(response0)
const response1 = await client.indices.create({
index: 'twitter-2'
})
console.log(response1)
const response2 = await client.indices.putMapping({
index: 'twitter-1,twitter-2',
body: {
properties: {
user_name: {
type: 'text'
}
}
}
})
console.log(response2)
----

View File

@ -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.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
user_id: {
type: 'keyword',
ignore_above: 20
}
}
}
}
})
console.log(response)
----

View File

@ -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)
----

View File

@ -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({
body: {
query: {
dis_max: {
queries: [
{
match_phrase_prefix: {
subject: 'quick brown f'
}
},
{
match_phrase_prefix: {
message: 'quick brown f'
}
}
]
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,38 @@
// 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: {
bool: {
should: [
{
multi_match: {
query: 'Will Smith',
type: 'cross_fields',
fields: [
'first',
'last'
],
minimum_should_match: '50%'
}
},
{
multi_match: {
query: 'Will Smith',
type: 'cross_fields',
fields: [
'*.edge'
]
}
}
]
}
}
}
})
console.log(response)
----

View File

@ -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.search({
index: '*',
q: 'user:kimchy'
})
console.log(response)
----

View File

@ -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: {
multi_match: {
query: 'this is a test',
fields: [
'subject',
'message'
]
}
}
}
})
console.log(response)
----

View File

@ -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.reindex({
body: {
source: {
index: 'users'
},
dest: {
index: 'new_users'
}
}
})
console.log(response)
----

View File

@ -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.indices.putMapping({
index: 'twitter',
body: {
properties: {
email: {
type: 'keyword'
}
}
}
})
console.log(response)
----

View File

@ -9,7 +9,7 @@ const response = await client.search({
range: {
timestamp: {
time_zone: '+01:00',
gte: '2015-01-01 00:00:00',
gte: '2020-01-01T00:00:00',
lte: 'now'
}
}

View File

@ -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: {
multi_match: {
query: 'brown fox',
type: 'best_fields',
fields: [
'subject',
'message'
],
tie_breaker: 0.3
}
}
}
})
console.log(response)
----

View File

@ -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.indices.putMapping({
index: 'my_index',
body: {
properties: {
city: {
type: 'text',
fields: {
raw: {
type: 'keyword'
}
}
}
}
}
})
console.log(response)
----

View File

@ -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: {
multi_match: {
query: 'quick brown f',
type: 'bool_prefix',
fields: [
'subject',
'message'
]
}
}
}
})
console.log(response)
----

View File

@ -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: {
multi_match: {
query: 'Will Smith',
fields: [
'title',
'*_name'
]
}
}
}
})
console.log(response)
----

View File

@ -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 response = await client.search({
body: {
query: {
bool: {
should: [
{
match: {
title: 'quick brown fox'
}
},
{
match: {
'title.original': 'quick brown fox'
}
},
{
match: {
'title.shingles': 'quick brown fox'
}
}
]
}
}
}
})
console.log(response)
----

View File

@ -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.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
user_identifier: {
type: 'keyword'
}
}
}
}
})
console.log(response)
----

View File

@ -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.indices.create({
index: 'new_users',
body: {
mappings: {
properties: {
user_id: {
type: 'keyword'
}
}
}
}
})
console.log(response)
----

View File

@ -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: {
multi_match: {
query: 'quick brown fox',
type: 'most_fields',
fields: [
'title',
'title.original',
'title.shingles'
]
}
}
}
})
console.log(response)
----

View File

@ -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.search({
index: '_all',
q: 'user:kimchy'
})
console.log(response)
----

View File

@ -0,0 +1,80 @@
// 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.bulk({
body: [
{
update: {
_id: '1',
_index: 'index1',
retry_on_conflict: 3
}
},
{
doc: {
field: 'value'
}
},
{
update: {
_id: '0',
_index: 'index1',
retry_on_conflict: 3
}
},
{
script: {
source: 'ctx._source.counter += params.param1',
lang: 'painless',
params: {
param1: 1
}
},
upsert: {
counter: 1
}
},
{
update: {
_id: '2',
_index: 'index1',
retry_on_conflict: 3
}
},
{
doc: {
field: 'value'
},
doc_as_upsert: true
},
{
update: {
_id: '3',
_index: 'index1',
_source: true
}
},
{
doc: {
field: 'value'
}
},
{
update: {
_id: '4',
_index: 'index1'
}
},
{
doc: {
field: 'value'
},
_source: true
}
]
})
console.log(response)
----

View File

@ -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.delete({
index: 'twitter'
})
console.log(response)
----

View File

@ -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.search({
index: 'twitter',
q: 'tag:wow'
})
console.log(response)
----

View File

@ -0,0 +1,24 @@
// 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: {
multi_match: {
query: 'Jon',
type: 'cross_fields',
fields: [
'first',
'first.edge',
'last',
'last.edge'
]
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,47 @@
// 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.bulk({
body: [
{
index: {
_index: 'test',
_id: '1'
}
},
{
field1: 'value1'
},
{
delete: {
_index: 'test',
_id: '2'
}
},
{
create: {
_index: 'test',
_id: '3'
}
},
{
field1: 'value3'
},
{
update: {
_id: '1',
_index: 'test'
}
},
{
doc: {
field2: 'value2'
}
}
]
})
console.log(response)
----

View File

@ -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: {
user_id: {
type: 'alias',
path: 'user_identifier'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,29 @@
// 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: {
dis_max: {
queries: [
{
match: {
subject: 'brown fox'
}
},
{
match: {
message: 'brown fox'
}
}
],
tie_breaker: 0.3
}
}
}
})
console.log(response)
----

View File

@ -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.indices.create({
index: 'users',
body: {
mappings: {
properties: {
user_id: {
type: 'long'
}
}
}
}
})
console.log(response)
----

View File

@ -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.search({
index: 'twitter',
q: 'user:kimchy'
})
console.log(response)
----

View File

@ -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.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
city: {
type: 'text'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,24 @@
// 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: {
name: {
properties: {
first: {
type: 'text'
}
}
}
}
}
}
})
console.log(response)
----

View File

@ -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: {
multi_match: {
query: 'Will Smith',
type: 'best_fields',
fields: [
'first_name',
'last_name'
],
operator: 'and'
}
}
}
})
console.log(response)
----

View File

@ -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: {
multi_match: {
query: 'this is a test',
fields: [
'subject^3',
'message'
]
}
}
}
})
console.log(response)
----

View File

@ -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.indices.putMapping({
index: 'publications',
body: {
properties: {
title: {
type: 'text'
}
}
}
})
console.log(response)
----

View File

@ -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.search({
index: 'kimchy,elasticsearch',
q: 'user:kimchy'
})
console.log(response)
----

View File

@ -4,7 +4,7 @@
[source, js]
----
const response = await client.cat.health({
v: ''
v: true
})
console.log(response)
----

View File

@ -44,7 +44,12 @@ const enabledFiles = [
'indices/create-index.asciidoc',
'docs/index_.asciidoc',
'aggregations/bucket/terms-aggregation.asciidoc',
'query-dsl/range-query.asciidoc'
'query-dsl/range-query.asciidoc',
'search/search.asciidoc',
'query-dsl/multi-match-query.asciidoc',
'docs/bulk.asciidoc',
'indices/delete-index.asciidoc',
'indices/put-mapping.asciidoc'
]
function generate () {