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

Hide arguments heading in docs when there are no arguments (#1928)

Browse Source
This commit is contained in:
Josh Mock
2023-06-30 11:15:31 -05:00
committed by GitHub
parent 960dff37f2
commit 3bf69c370e
4 changed files with 155 additions and 309 deletions
Download Patch File Download Diff File Expand all files Collapse all files

280
docs/reference.asciidoc
View File

@ -395,10 +395,6 @@ Returns all script contexts.
----
client.getScriptContext()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== get_script_languages
@ -409,10 +405,6 @@ Returns available script types, languages and contexts
----
client.getScriptLanguages()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== get_source
@ -494,10 +486,6 @@ Returns basic information about the cluster.
----
client.info()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== knn_search
@ -662,10 +650,6 @@ Returns whether the cluster is running.
----
client.ping()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== put_script
@ -1423,10 +1407,6 @@ Returns help for the Cat APIs.
client.cat.help()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== indices
@ -1461,10 +1441,6 @@ Returns information about the master node.
client.cat.master()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== ml_data_frame_analytics
@ -1579,10 +1555,6 @@ Returns information about custom node attributes.
client.cat.nodeattrs()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== nodes
@ -1612,10 +1584,6 @@ Returns a concise representation of the cluster pending tasks.
client.cat.pendingTasks()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== plugins
@ -1627,10 +1595,6 @@ Returns information about installed plugins across nodes node.
client.cat.plugins()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== recovery
@ -1662,10 +1626,6 @@ Returns information about snapshot repositories registered in the cluster.
client.cat.repositories()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== segments
@ -2035,10 +1995,6 @@ Gets all stats related to cross-cluster replication.
client.ccr.stats()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== unfollow
@ -2094,8 +2050,10 @@ client.cluster.deleteComponentTemplate({ name })
* *Request (object):*
** *`name` (string | string[])*: List or wildcard expression of component template names used to limit the request.
** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master
** *`timeout` (Optional, string | -1 | 0)*: Explicit operation timeout
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== delete_voting_config_exclusions
@ -2154,11 +2112,14 @@ client.cluster.getComponentTemplate({ ... })
==== Arguments
* *Request (object):*
** *`name` (Optional, string)*: The comma separated names of the component templates
** *`flat_settings` (Optional, boolean)*
** *`local` (Optional, boolean)*: Return local information, do not retrieve the state from master node (default: false)
** *`master_timeout` (Optional, string | -1 | 0)*: Explicit operation timeout for connection to master node
** *`name` (Optional, string)*: List of component template names used to limit the request.
Wildcard (`*`) expressions are supported.
** *`flat_settings` (Optional, boolean)*: If `true`, returns settings in flat format.
** *`include_defaults` (Optional, boolean)*: Return all default configurations for the component template (default: false)
** *`local` (Optional, boolean)*: If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node.
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== get_settings
@ -2174,10 +2135,12 @@ client.cluster.getSettings({ ... })
==== Arguments
* *Request (object):*
** *`flat_settings` (Optional, boolean)*: Return settings in flat format (default: false)
** *`include_defaults` (Optional, boolean)*: Whether to return all default clusters setting.
** *`master_timeout` (Optional, string | -1 | 0)*: Explicit operation timeout for connection to master node
** *`timeout` (Optional, string | -1 | 0)*: Explicit operation timeout
** *`flat_settings` (Optional, boolean)*: If `true`, returns settings in flat format.
** *`include_defaults` (Optional, boolean)*: If `true`, returns default cluster settings from the local node.
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== health
@ -2279,18 +2242,26 @@ client.cluster.putComponentTemplate({ name, template })
==== Arguments
* *Request (object):*
** *`name` (string)*: The name of the template
** *`name` (string)*: Name of the component template to create.
Elasticsearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.
Elastic Agent uses these templates to configure backing indices for its data streams.
If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.
** *`template` ({ aliases, mappings, settings, defaults, data_stream, lifecycle })*: The template to be applied which includes mappings, settings, or aliases configuration.
** *`create` (Optional, boolean)*: Whether the index template should only be added if new or can also replace an existing one
** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master
** *`version` (Optional, number)*: Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
** *`_meta` (Optional, Record<string, User-defined value>)*: Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
** *`create` (Optional, boolean)*: If `true`, this request cannot replace or update existing component templates.
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error.
** *`allow_auto_create` (Optional, boolean)*: This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that
template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false` then data streams matching the template must always be explicitly created.
** *`version` (Optional, number)*: Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
To unset a version, replace the template without specifying a version.
** *`_meta` (Optional, Record<string, User-defined value>)*: Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
This information is stored in the cluster state, so keeping it short is preferable.
To unset `_meta`, replace the template without specifying this information.
[discrete]
==== put_settings
@ -2322,10 +2293,6 @@ Returns the information about configured remote clusters.
client.cluster.remoteInfo()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== reroute
@ -2389,8 +2356,10 @@ client.cluster.stats({ ... })
* *Request (object):*
** *`node_id` (Optional, string | string[])*: List of node filters used to limit returned information. Defaults to all nodes in the cluster.
** *`flat_settings` (Optional, boolean)*: Return settings in flat format (default: false)
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.
** *`flat_settings` (Optional, boolean)*: If `true`, returns settings in flat format.
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for each node to respond.
If a node does not respond before its timeout expires, the response does not include its stats.
However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout.
[discrete]
=== dangling_indices
@ -2442,10 +2411,6 @@ Returns all dangling indices.
client.danglingIndices.listDanglingIndices()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== enrich
@ -2527,10 +2492,6 @@ Gets enrich coordinator statistics and information about enrich policies that ar
client.enrich.stats()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== eql
@ -2629,10 +2590,6 @@ Gets a list of features which can be included in snapshots using the feature_sta
client.features.getFeatures()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== reset_features
@ -2644,10 +2601,6 @@ Resets the internal state of features, usually by deleting system indices
client.features.resetFeatures()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== fleet
@ -2882,10 +2835,6 @@ Retrieves the current index lifecycle management (ILM) status.
client.ilm.getStatus()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== migrate_to_data_tiers
@ -3163,7 +3112,12 @@ client.indices.createDataStream({ name })
==== Arguments
* *Request (object):*
** *`name` (string)*: The name of the data stream
** *`name` (string)*: Name of the data stream, which must meet the following criteria:
Lowercase only;
Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character;
Cannot start with `-`, `_`, `+`, or `.ds-`;
Cannot be `.` or `..`;
Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.
[discrete]
==== data_streams_stats
@ -3255,8 +3209,8 @@ client.indices.deleteDataStream({ name })
==== Arguments
* *Request (object):*
** *`name` (string | string[])*: A list of data streams to delete; use `*` to delete all data streams
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether wildcard expressions should get expanded to open or closed indices (default: open)
** *`name` (string | string[])*: List of data streams to delete. Wildcard (`*`) expressions are supported.
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of data stream that wildcard patterns can match. Supports a list of values,such as `open,hidden`.
[discrete]
==== delete_index_template
@ -3586,8 +3540,10 @@ client.indices.getDataStream({ ... })
==== Arguments
* *Request (object):*
** *`name` (Optional, string | string[])*: A list of data streams to get; use `*` to get all data streams
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether wildcard expressions should get expanded to open or closed indices (default: open)
** *`name` (Optional, string | string[])*: List of data stream names used to limit the request.
Wildcard (`*`) expressions are supported. If omitted, all data streams are returned.
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of data stream that wildcard patterns can match.
Supports a list of values, such as `open,hidden`.
** *`include_defaults` (Optional, boolean)*: If true, returns all relevant default configurations for the index template.
[discrete]
@ -4296,10 +4252,6 @@ Returns statistical information about geoip databases
client.ingest.geoIpStats()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get_pipeline
@ -4329,10 +4281,6 @@ Returns a list of the built-in patterns.
client.ingest.processorGrok()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== put_pipeline
@ -4389,10 +4337,6 @@ Deletes licensing information for the cluster
client.license.delete()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get
@ -4422,10 +4366,6 @@ Retrieves information about the status of the basic license.
client.license.getBasicStatus()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get_trial_status
@ -4437,10 +4377,6 @@ Retrieves information about the status of the trial license.
client.license.getTrialStatus()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== post
@ -4571,10 +4507,6 @@ Find out whether system features need to be upgraded or not
client.migration.getFeatureUpgradeStatus()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== post_feature_upgrade
@ -4586,10 +4518,6 @@ Begin upgrades for system features
client.migration.postFeatureUpgrade()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== ml
@ -5572,10 +5500,6 @@ Returns defaults and limits used by machine learning.
client.ml.info()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== open_job
@ -6436,10 +6360,6 @@ Updates certain properties of trained model deployment.
client.ml.updateTrainedModelDeployment()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== upgrade_job_snapshot
@ -6866,10 +6786,6 @@ http://todo.com/tbd[Endpoint documentation]
client.searchApplication.postBehavioralAnalyticsEvent()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== put
@ -6914,10 +6830,6 @@ Renders a query for given search application search parameters
client.searchApplication.renderQuery()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== search
@ -7029,10 +6941,6 @@ Enables authentication as a user and retrieve information about the authenticate
client.security.authenticate()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== bulk_update_api_keys
@ -7044,10 +6952,6 @@ Updates the attributes of multiple existing API keys.
client.security.bulkUpdateApiKeys()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== change_password
@ -7185,10 +7089,6 @@ Creates a cross-cluster API key for API key based remote cluster access.
client.security.createCrossClusterApiKey()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== create_service_token
@ -7341,10 +7241,6 @@ Allows a kibana instance to configure itself to communicate with a secured elast
client.security.enrollKibana()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== enroll_node
@ -7356,10 +7252,6 @@ Allows a new node to enroll to an existing cluster with security enabled.
client.security.enrollNode()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get_api_key
@ -7395,10 +7287,6 @@ Retrieves the list of cluster privileges and index privileges that are available
client.security.getBuiltinPrivileges()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get_privileges
@ -7629,10 +7517,6 @@ Exchanges an OpenID Connection authentication response message for an Elasticsea
client.security.oidcAuthenticate()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== oidc_logout
@ -7644,10 +7528,6 @@ Invalidates a refresh token and access token that was generated from the OpenID
client.security.oidcLogout()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== oidc_prepare_authentication
@ -7659,10 +7539,6 @@ Creates an OAuth 2.0 authentication request as a URL string
client.security.oidcPrepareAuthentication()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== put_privileges
@ -7923,10 +7799,6 @@ Updates attributes of an existing cross-cluster API key.
client.security.updateCrossClusterApiKey()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== slm
@ -7972,10 +7844,6 @@ Deletes any snapshots that are expired according to the policy's retention rules
client.slm.executeRetention()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get_lifecycle
@ -8003,10 +7871,6 @@ Returns global and policy-level statistics about actions taken by snapshot lifec
client.slm.getStats()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get_status
@ -8018,10 +7882,6 @@ Retrieves the status of snapshot lifecycle management (SLM).
client.slm.getStatus()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== put_lifecycle
@ -8056,10 +7916,6 @@ Turns on snapshot lifecycle management (SLM).
client.slm.start()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== stop
@ -8071,10 +7927,6 @@ Turns off snapshot lifecycle management (SLM).
client.slm.stop()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== snapshot
@ -8259,10 +8111,6 @@ Analyzes a repository for correctness and performance
client.snapshot.repositoryAnalyze()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== restore
@ -8467,10 +8315,6 @@ Retrieves information about the X.509 certificates used to encrypt communication
client.ssl.certificates()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== synonyms
@ -8484,10 +8328,6 @@ Deletes a synonym set
client.synonyms.delete()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get
@ -8499,10 +8339,6 @@ Retrieves a synonym set
client.synonyms.get()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== put
@ -8514,10 +8350,6 @@ Creates or updates a synonyms set
client.synonyms.put()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== tasks
@ -9007,10 +8839,6 @@ Retrieve settings for the watcher system index
client.watcher.getSettings()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== get_watch
@ -9085,10 +8913,6 @@ Starts Watcher if it is not already running.
client.watcher.start()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== stats
@ -9117,10 +8941,6 @@ Stops Watcher if it is running.
client.watcher.stop()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
==== update_settings
@ -9132,10 +8952,6 @@ Update settings for the watcher system index
client.watcher.updateSettings()
----
[discrete]
==== Arguments
* *Request (object):*
[discrete]
=== xpack