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

API generation

Browse Source
This commit is contained in:
delvedor
2020-03-11 19:12:21 +01:00
parent cf5f3c55e0
commit db67c526e4
1 changed files with 38 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/reference.asciidoc
View File

@ -1,4 +1,37 @@
[[api-reference]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in '/scripts/utils/generateDocs.js'. ||
|| ||
|| You can run the script with the following command: ||
|| node scripts/generate --branch <branch_name> ||
|| or ||
|| node scripts/generate --tag <tag_name> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
== API Reference
This document contains the entire list of the Elasticsearch API supported by the client, both OSS and commercial. The client is entirely licensed under Apache 2.0.
@ -21,7 +54,7 @@ const result = await client.search({
maxRetries: 3
})
// calback API
// callback API
client.search({
index: 'my-index',
from: 20,
@ -37,14 +70,7 @@ client.search({
In this document, you will find the reference of every parameter accepted by the querystring or the url. If you also need to send the body, you can find the documentation of its format in the reference link that is present along with every endpoint.
////////
This documentation is generated by running:
node scripts/run.js --tag tagName
or
node scripts/run.js --branch branchName
////////
=== Common parameters
Parameters that are accepted by all API endpoints.
@ -8346,7 +8372,7 @@ client.slm.executeLifecycle({
policy_id: string
})
----
link:{ref}/slm-api-execute-lifecycle.html[Documentation] +
link:{ref}/slm-api-execute-policy.html[Documentation] +
[cols=2*]
|===
|`policy_id` or `policyId`
@ -8394,7 +8420,7 @@ link:{ref}/slm-api-get-stats.html[Documentation] +
----
client.slm.getStatus()
----
link:{ref}/slm-api-get-status.html[Documentation] +
link:{ref}/slm-get-status.html[Documentation] +
=== slm.putLifecycle
@ -8423,7 +8449,7 @@ link:{ref}/slm-api-put-policy.html[Documentation] +
----
client.slm.start()
----
link:{ref}/slm-api-start.html[Documentation] +
link:{ref}/slm-start.html[Documentation] +
=== slm.stop
@ -8432,7 +8458,7 @@ link:{ref}/slm-api-start.html[Documentation] +
----
client.slm.stop()
----
link:{ref}/slm-api-stop.html[Documentation] +
link:{ref}/slm-stop.html[Documentation] +
=== sql.clearCursor