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
2019-05-06 12:04:41 +02:00
parent 62e9805311
commit 8136846a78
16 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api/api/ingest.delete_pipeline.js
View File

@ -26,7 +26,7 @@ function buildIngestDeletePipeline (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [ingest.delete_pipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html) request
* Perform a [ingest.delete_pipeline](https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html) request
*
* @param {string} id - Pipeline ID
* @param {time} master_timeout - Explicit operation timeout for connection to master node

2
api/api/ingest.get_pipeline.js
View File

@ -26,7 +26,7 @@ function buildIngestGetPipeline (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [ingest.get_pipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html) request
* Perform a [ingest.get_pipeline](https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html) request
*
* @param {string} id - Comma separated list of pipeline ids. Wildcards supported
* @param {time} master_timeout - Explicit operation timeout for connection to master node

2
api/api/ingest.processor_grok.js
View File

@ -26,7 +26,7 @@ function buildIngestProcessorGrok (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [ingest.processor_grok](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html) request
* Perform a [ingest.processor_grok](https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get) request
*
*/

2
api/api/ingest.put_pipeline.js
View File

@ -26,7 +26,7 @@ function buildIngestPutPipeline (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [ingest.put_pipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html) request
* Perform a [ingest.put_pipeline](https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html) request
*
* @param {string} id - Pipeline ID
* @param {time} master_timeout - Explicit operation timeout for connection to master node

2
api/api/ingest.simulate.js
View File

@ -26,7 +26,7 @@ function buildIngestSimulate (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html) request
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html) request
*
* @param {string} id - Pipeline ID
* @param {boolean} verbose - Verbose mode. Display data output for each processor in executed pipeline

2
api/api/license.delete.js
View File

@ -26,7 +26,7 @@ function buildLicenseDelete (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [license.delete](https://www.elastic.co/guide/en/x-pack/current/license-management.html) request
* Perform a [license.delete](https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html) request
*
*/

2
api/api/license.get.js
View File

@ -26,7 +26,7 @@ function buildLicenseGet (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [license.get](https://www.elastic.co/guide/en/x-pack/current/license-management.html) request
* Perform a [license.get](https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html) request
*
* @param {boolean} local - Return local information, do not retrieve the state from master node (default: false)
*/

2
api/api/license.get_basic_status.js
View File

@ -26,7 +26,7 @@ function buildLicenseGetBasicStatus (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [license.get_basic_status](https://www.elastic.co/guide/en/x-pack/current/license-management.html) request
* Perform a [license.get_basic_status](https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html) request
*
*/

2
api/api/license.get_trial_status.js
View File

@ -26,7 +26,7 @@ function buildLicenseGetTrialStatus (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [license.get_trial_status](https://www.elastic.co/guide/en/x-pack/current/license-management.html) request
* Perform a [license.get_trial_status](https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html) request
*
*/

2
api/api/license.post.js
View File

@ -26,7 +26,7 @@ function buildLicensePost (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [license.post](https://www.elastic.co/guide/en/x-pack/current/license-management.html) request
* Perform a [license.post](https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html) request
*
* @param {boolean} acknowledge - whether the user has acknowledged acknowledge messages (default: false)
* @param {object} body - licenses to be installed

2
api/api/license.post_start_basic.js
View File

@ -26,7 +26,7 @@ function buildLicensePostStartBasic (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [license.post_start_basic](https://www.elastic.co/guide/en/x-pack/current/license-management.html) request
* Perform a [license.post_start_basic](https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html) request
*
* @param {boolean} acknowledge - whether the user has acknowledged acknowledge messages (default: false)
*/

2
api/api/license.post_start_trial.js
View File

@ -26,7 +26,7 @@ function buildLicensePostStartTrial (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [license.post_start_trial](https://www.elastic.co/guide/en/x-pack/current/license-management.html) request
* Perform a [license.post_start_trial](https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html) request
*
* @param {string} type - The type of trial license to generate (default: "trial")
* @param {boolean} acknowledge - whether the user has acknowledged acknowledge messages (default: false)

2
api/api/migration.deprecations.js
View File

@ -26,7 +26,7 @@ function buildMigrationDeprecations (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [migration.deprecations](http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html) request
* Perform a [migration.deprecations](http://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html) request
*
* @param {string} index - Index pattern
*/

2
api/api/ml.find_file_structure.js
View File

@ -26,7 +26,7 @@ function buildMlFindFileStructure (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [ml.find_file_structure](http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-file-structure.html) request
* Perform a [ml.find_file_structure](http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html) request
*
* @param {int} lines_to_sample - How many lines of the file should be included in the analysis
* @param {time} timeout - Timeout after which the analysis will be aborted

2
api/api/monitoring.bulk.js
View File

@ -26,7 +26,7 @@ function buildMonitoringBulk (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [monitoring.bulk](http://www.elastic.co/guide/en/monitoring/current/appendix-api-bulk.html) request
* Perform a [monitoring.bulk](https://www.elastic.co/guide/en/elasticsearch/reference/master/es-monitoring.html) request
*
* @param {string} type - Default document type for items which don't provide one
* @param {string} system_id - Identifier of the monitored system

2
api/api/security.get_user_privileges.js
View File

@ -26,7 +26,7 @@ function buildSecurityGetUserPrivileges (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
/**
* Perform a [security.get_user_privileges](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html) request
* Perform a [security.get_user_privileges](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html) request
*
*/