regenerate api docs

docs/api_methods.asciidoc

@@ -1312,8 +1312,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -1328,8 +1328,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -1349,6 +1349,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -1357,13 +1358,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1372,8 +1374,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------

docs/api_methods_0_90.asciidoc

@@ -952,8 +952,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -968,8 +968,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -989,6 +989,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -997,13 +998,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1012,8 +1014,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------

docs/api_methods_1_0.asciidoc

@@ -1101,8 +1101,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -1117,8 +1117,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -1138,6 +1138,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -1146,13 +1147,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1161,8 +1163,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------

docs/api_methods_1_1.asciidoc

@@ -1113,8 +1113,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -1129,8 +1129,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -1150,6 +1150,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -1158,13 +1159,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1173,8 +1175,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------

docs/api_methods_1_2.asciidoc

@@ -1113,8 +1113,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -1129,8 +1129,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -1150,6 +1150,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -1158,13 +1159,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1173,8 +1175,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------

docs/api_methods_1_3.asciidoc

@@ -1209,8 +1209,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -1225,8 +1225,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -1246,6 +1246,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -1254,13 +1255,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1269,8 +1271,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------

docs/api_methods_1_4.asciidoc

@@ -1265,8 +1265,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -1281,8 +1281,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -1302,6 +1302,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -1310,13 +1311,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1325,8 +1327,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------

docs/api_methods_1_5.asciidoc

@@ -1269,8 +1269,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 [source,js]
 ---------
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-1',
   body: {
     // This query will be run against documents sent to percolate
@@ -1285,8 +1285,8 @@ client.index({
 });
 
 client.index({
-  index: '_percolator',
+  index: 'myindex',
-  type: 'myindex',
+  type: '.percolator',
   id: 'alert-2',
   body: {
     // This query will also be run against documents sent to percolate
@@ -1306,6 +1306,7 @@ client.index({
 ---------
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo"
@@ -1314,13 +1315,14 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 1,
-  //   matches: [ "alert-1" ]
+  //   matches: [ { _index: 'myindex', _id: 'alert-1' } ]
   // }
 });
 
 client.percolate({
   index: 'myindex',
+  type: 'mytype',
   body: {
     doc: {
       title: "Foo Bar"
@@ -1329,8 +1331,11 @@ client.percolate({
 }, function (error, response) {
   // response would equal
   // {
-  //   ok:true,
+  //   total: 2,
-  //   matches: [ "alert-1", "alert-2" ]
+  //   matches: [
+  //     { _index: 'myindex', _id: 'alert-1' },
+  //     { _index: 'myindex', _id: 'alert-2' }
+  //   ]
   // }
 });
 ---------