habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[DOCS] More xref fixes.

Browse Source
This commit is contained in:
Deb Adair
2017-07-24 20:23:38 -07:00
parent 139d2266dd
commit 7f0d0d6f47
2 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/api_methods.asciidoc
View File

@ -15,7 +15,7 @@ client.bulk([params, [callback]])
Perform many index/delete operations in a single API call.
Check the *<<api-conventions>>* and /docs-bulk.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref}/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method.
.Perform three operations in a single request
[source,js]
@ -1699,7 +1699,7 @@ client.renderSearchTemplate([params, [callback]])
// no description
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref}/search-template.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1710,7 +1710,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`id`::
<<api-param-type-string,`String`>> -- The id of the stored search template
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref}/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3748,7 +3748,7 @@ client.indices.exists([params, [callback]])
Return a boolean indicating whether given index exists.
Check the *<<api-conventions>>* and http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref}/indices-exists.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -3777,7 +3777,7 @@ Options:::
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref}/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4893,7 +4893,7 @@ client.ingest.deletePipeline([params, [callback]])
// no description
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {plugins-50}/ingest.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -4908,7 +4908,7 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
`id`::
<<api-param-type-string,`String`>> -- Pipeline ID
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {plugins-50}/ingest.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4922,7 +4922,7 @@ client.ingest.getPipeline([params, [callback]])
// no description
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref}/ingest.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -4947,7 +4947,7 @@ client.ingest.putPipeline([params, [callback]])
// no description
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {plugins-50}/ingest.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -4962,7 +4962,7 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
`id`::
<<api-param-type-string,`String`>> -- Pipeline ID
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See {plugins-50}/ingest.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4976,7 +4976,7 @@ client.ingest.simulate([params, [callback]])
// no description
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {plugins-50}/ingest.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -4989,7 +4989,7 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
`id`::
<<api-param-type-string,`String`>> -- Pipeline ID
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See {plugins-50}/ingest.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]

20
docs/api_methods_5_0.asciidoc
View File

@ -15,7 +15,7 @@ client.bulk([params, [callback]])
Perform many index/delete operations in a single API call.
Check the *<<api-conventions>>* and {ref-50}/5.6/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref-50}/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method.
.Perform three operations in a single request
[source,js]
@ -72,7 +72,7 @@ Options:::
`index`::
<<api-param-type-string,`String`>> -- Default index for items which don't provide one
`body`::
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-50}/5.6/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-50}/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -86,7 +86,7 @@ client.clearScroll([params, [callback]])
Clear the scroll request created by specifying the scroll parameter to search.
Check the *<<api-conventions>>* and {ref-50}/5.6/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref-50}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -97,7 +97,7 @@ Check the *<<api-conventions>>* and {ref-50}/5.6/search-request-scroll.html[the
`scrollId`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of scroll IDs to clear
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/5.6//search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -111,7 +111,7 @@ client.count([params, [callback]])
Get the number of documents for the cluster, index, type, or a query.
Check the *<<api-conventions>>* and {ref-50}/5.6//search-count.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref-50}/search-count.html[the elasticsearch docs] for more information pertaining to this method.
.Get the number of all documents in the cluster
[source,js]
@ -199,7 +199,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of types to restrict the results
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/5.6/search-count.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/search-count.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -213,7 +213,7 @@ client.countPercolate([params, [callback]])
// no description
Check the *<<api-conventions>>* and {ref-50}/5.6/search-percolate.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref-50}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -258,7 +258,7 @@ Options:::
`id`::
<<api-param-type-string,`String`>> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/5.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -272,7 +272,7 @@ client.create([params, [callback]])
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.
Check the *<<api-conventions>>* and {ref-50}/5.6/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and {ref-50}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
.Create a document
[source,js]
@ -336,7 +336,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>> -- The type of the document
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/5.6/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]