Skip to content

Commit eebd7d1

Browse files
author
Spencer Alger
committed
regenerate api docs
1 parent d56578b commit eebd7d1

8 files changed

+104
-64
lines changed

‎docs/api_methods.asciidoc‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1312,8 +1312,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
13121312
[source,js]
13131313
---------
13141314
client.index({
1315-
index: '_percolator',
1316-
type: 'myindex',
1315+
index: 'myindex',
1316+
type: '.percolator',
13171317
id: 'alert-1',
13181318
body: {
13191319
// This query will be run against documents sent to percolate
@@ -1328,8 +1328,8 @@ client.index({
13281328
});
13291329
13301330
client.index({
1331-
index: '_percolator',
1332-
type: 'myindex',
1331+
index: 'myindex',
1332+
type: '.percolator',
13331333
id: 'alert-2',
13341334
body: {
13351335
// This query will also be run against documents sent to percolate
@@ -1349,6 +1349,7 @@ client.index({
13491349
---------
13501350
client.percolate({
13511351
index: 'myindex',
1352+
type: 'mytype',
13521353
body: {
13531354
doc: {
13541355
title: "Foo"
@@ -1357,13 +1358,14 @@ client.percolate({
13571358
}, function (error, response) {
13581359
// response would equal
13591360
// {
1360-
// ok:true,
1361-
// matches: [ "alert-1" ]
1361+
// total: 1,
1362+
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
13621363
// }
13631364
});
13641365
13651366
client.percolate({
13661367
index: 'myindex',
1368+
type: 'mytype',
13671369
body: {
13681370
doc: {
13691371
title: "Foo Bar"
@@ -1372,8 +1374,11 @@ client.percolate({
13721374
}, function (error, response) {
13731375
// response would equal
13741376
// {
1375-
// ok:true,
1376-
// matches: [ "alert-1", "alert-2" ]
1377+
// total: 2,
1378+
// matches: [
1379+
// { _index: 'myindex', _id: 'alert-1' },
1380+
// { _index: 'myindex', _id: 'alert-2' }
1381+
// ]
13771382
// }
13781383
});
13791384
---------

‎docs/api_methods_0_90.asciidoc‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -952,8 +952,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
952952
[source,js]
953953
---------
954954
client.index({
955-
index: '_percolator',
956-
type: 'myindex',
955+
index: 'myindex',
956+
type: '.percolator',
957957
id: 'alert-1',
958958
body: {
959959
// This query will be run against documents sent to percolate
@@ -968,8 +968,8 @@ client.index({
968968
});
969969
970970
client.index({
971-
index: '_percolator',
972-
type: 'myindex',
971+
index: 'myindex',
972+
type: '.percolator',
973973
id: 'alert-2',
974974
body: {
975975
// This query will also be run against documents sent to percolate
@@ -989,6 +989,7 @@ client.index({
989989
---------
990990
client.percolate({
991991
index: 'myindex',
992+
type: 'mytype',
992993
body: {
993994
doc: {
994995
title: "Foo"
@@ -997,13 +998,14 @@ client.percolate({
997998
}, function (error, response) {
998999
// response would equal
9991000
// {
1000-
// ok:true,
1001-
// matches: [ "alert-1" ]
1001+
// total: 1,
1002+
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
10021003
// }
10031004
});
10041005
10051006
client.percolate({
10061007
index: 'myindex',
1008+
type: 'mytype',
10071009
body: {
10081010
doc: {
10091011
title: "Foo Bar"
@@ -1012,8 +1014,11 @@ client.percolate({
10121014
}, function (error, response) {
10131015
// response would equal
10141016
// {
1015-
// ok:true,
1016-
// matches: [ "alert-1", "alert-2" ]
1017+
// total: 2,
1018+
// matches: [
1019+
// { _index: 'myindex', _id: 'alert-1' },
1020+
// { _index: 'myindex', _id: 'alert-2' }
1021+
// ]
10171022
// }
10181023
});
10191024
---------

‎docs/api_methods_1_0.asciidoc‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1101,8 +1101,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
11011101
[source,js]
11021102
---------
11031103
client.index({
1104-
index: '_percolator',
1105-
type: 'myindex',
1104+
index: 'myindex',
1105+
type: '.percolator',
11061106
id: 'alert-1',
11071107
body: {
11081108
// This query will be run against documents sent to percolate
@@ -1117,8 +1117,8 @@ client.index({
11171117
});
11181118
11191119
client.index({
1120-
index: '_percolator',
1121-
type: 'myindex',
1120+
index: 'myindex',
1121+
type: '.percolator',
11221122
id: 'alert-2',
11231123
body: {
11241124
// This query will also be run against documents sent to percolate
@@ -1138,6 +1138,7 @@ client.index({
11381138
---------
11391139
client.percolate({
11401140
index: 'myindex',
1141+
type: 'mytype',
11411142
body: {
11421143
doc: {
11431144
title: "Foo"
@@ -1146,13 +1147,14 @@ client.percolate({
11461147
}, function (error, response) {
11471148
// response would equal
11481149
// {
1149-
// ok:true,
1150-
// matches: [ "alert-1" ]
1150+
// total: 1,
1151+
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
11511152
// }
11521153
});
11531154
11541155
client.percolate({
11551156
index: 'myindex',
1157+
type: 'mytype',
11561158
body: {
11571159
doc: {
11581160
title: "Foo Bar"
@@ -1161,8 +1163,11 @@ client.percolate({
11611163
}, function (error, response) {
11621164
// response would equal
11631165
// {
1164-
// ok:true,
1165-
// matches: [ "alert-1", "alert-2" ]
1166+
// total: 2,
1167+
// matches: [
1168+
// { _index: 'myindex', _id: 'alert-1' },
1169+
// { _index: 'myindex', _id: 'alert-2' }
1170+
// ]
11661171
// }
11671172
});
11681173
---------

‎docs/api_methods_1_1.asciidoc‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,8 +1113,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
11131113
[source,js]
11141114
---------
11151115
client.index({
1116-
index: '_percolator',
1117-
type: 'myindex',
1116+
index: 'myindex',
1117+
type: '.percolator',
11181118
id: 'alert-1',
11191119
body: {
11201120
// This query will be run against documents sent to percolate
@@ -1129,8 +1129,8 @@ client.index({
11291129
});
11301130
11311131
client.index({
1132-
index: '_percolator',
1133-
type: 'myindex',
1132+
index: 'myindex',
1133+
type: '.percolator',
11341134
id: 'alert-2',
11351135
body: {
11361136
// This query will also be run against documents sent to percolate
@@ -1150,6 +1150,7 @@ client.index({
11501150
---------
11511151
client.percolate({
11521152
index: 'myindex',
1153+
type: 'mytype',
11531154
body: {
11541155
doc: {
11551156
title: "Foo"
@@ -1158,13 +1159,14 @@ client.percolate({
11581159
}, function (error, response) {
11591160
// response would equal
11601161
// {
1161-
// ok:true,
1162-
// matches: [ "alert-1" ]
1162+
// total: 1,
1163+
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
11631164
// }
11641165
});
11651166
11661167
client.percolate({
11671168
index: 'myindex',
1169+
type: 'mytype',
11681170
body: {
11691171
doc: {
11701172
title: "Foo Bar"
@@ -1173,8 +1175,11 @@ client.percolate({
11731175
}, function (error, response) {
11741176
// response would equal
11751177
// {
1176-
// ok:true,
1177-
// matches: [ "alert-1", "alert-2" ]
1178+
// total: 2,
1179+
// matches: [
1180+
// { _index: 'myindex', _id: 'alert-1' },
1181+
// { _index: 'myindex', _id: 'alert-2' }
1182+
// ]
11781183
// }
11791184
});
11801185
---------

‎docs/api_methods_1_2.asciidoc‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,8 +1113,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
11131113
[source,js]
11141114
---------
11151115
client.index({
1116-
index: '_percolator',
1117-
type: 'myindex',
1116+
index: 'myindex',
1117+
type: '.percolator',
11181118
id: 'alert-1',
11191119
body: {
11201120
// This query will be run against documents sent to percolate
@@ -1129,8 +1129,8 @@ client.index({
11291129
});
11301130
11311131
client.index({
1132-
index: '_percolator',
1133-
type: 'myindex',
1132+
index: 'myindex',
1133+
type: '.percolator',
11341134
id: 'alert-2',
11351135
body: {
11361136
// This query will also be run against documents sent to percolate
@@ -1150,6 +1150,7 @@ client.index({
11501150
---------
11511151
client.percolate({
11521152
index: 'myindex',
1153+
type: 'mytype',
11531154
body: {
11541155
doc: {
11551156
title: "Foo"
@@ -1158,13 +1159,14 @@ client.percolate({
11581159
}, function (error, response) {
11591160
// response would equal
11601161
// {
1161-
// ok:true,
1162-
// matches: [ "alert-1" ]
1162+
// total: 1,
1163+
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
11631164
// }
11641165
});
11651166
11661167
client.percolate({
11671168
index: 'myindex',
1169+
type: 'mytype',
11681170
body: {
11691171
doc: {
11701172
title: "Foo Bar"
@@ -1173,8 +1175,11 @@ client.percolate({
11731175
}, function (error, response) {
11741176
// response would equal
11751177
// {
1176-
// ok:true,
1177-
// matches: [ "alert-1", "alert-2" ]
1178+
// total: 2,
1179+
// matches: [
1180+
// { _index: 'myindex', _id: 'alert-1' },
1181+
// { _index: 'myindex', _id: 'alert-2' }
1182+
// ]
11781183
// }
11791184
});
11801185
---------

‎docs/api_methods_1_3.asciidoc‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1209,8 +1209,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
12091209
[source,js]
12101210
---------
12111211
client.index({
1212-
index: '_percolator',
1213-
type: 'myindex',
1212+
index: 'myindex',
1213+
type: '.percolator',
12141214
id: 'alert-1',
12151215
body: {
12161216
// This query will be run against documents sent to percolate
@@ -1225,8 +1225,8 @@ client.index({
12251225
});
12261226
12271227
client.index({
1228-
index: '_percolator',
1229-
type: 'myindex',
1228+
index: 'myindex',
1229+
type: '.percolator',
12301230
id: 'alert-2',
12311231
body: {
12321232
// This query will also be run against documents sent to percolate
@@ -1246,6 +1246,7 @@ client.index({
12461246
---------
12471247
client.percolate({
12481248
index: 'myindex',
1249+
type: 'mytype',
12491250
body: {
12501251
doc: {
12511252
title: "Foo"
@@ -1254,13 +1255,14 @@ client.percolate({
12541255
}, function (error, response) {
12551256
// response would equal
12561257
// {
1257-
// ok:true,
1258-
// matches: [ "alert-1" ]
1258+
// total: 1,
1259+
// matches: [ { _index: 'myindex', _id: 'alert-1' } ]
12591260
// }
12601261
});
12611262
12621263
client.percolate({
12631264
index: 'myindex',
1265+
type: 'mytype',
12641266
body: {
12651267
doc: {
12661268
title: "Foo Bar"
@@ -1269,8 +1271,11 @@ client.percolate({
12691271
}, function (error, response) {
12701272
// response would equal
12711273
// {
1272-
// ok:true,
1273-
// matches: [ "alert-1", "alert-2" ]
1274+
// total: 2,
1275+
// matches: [
1276+
// { _index: 'myindex', _id: 'alert-1' },
1277+
// { _index: 'myindex', _id: 'alert-2' }
1278+
// ]
12741279
// }
12751280
});
12761281
---------

0 commit comments

Comments
 (0)