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

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

View File

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

View File

@ -346,7 +346,7 @@ export default class Cluster {
async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise<T.ClusterPutComponentTemplateResponse> async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise<T.ClusterPutComponentTemplateResponse>
async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise<any> { async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['name'] const acceptedPath: string[] = ['name']
const acceptedBody: string[] = ['template', 'version', '_meta', 'allow_auto_create'] const acceptedBody: string[] = ['allow_auto_create', 'template', 'version', '_meta']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
// @ts-expect-error // @ts-expect-error
const userBody: any = params?.body const userBody: any = params?.body

View File

@ -517,6 +517,7 @@ export interface HealthReportIndicators {
repository_integrity?: HealthReportRepositoryIntegrityIndicator repository_integrity?: HealthReportRepositoryIntegrityIndicator
ilm?: HealthReportIlmIndicator ilm?: HealthReportIlmIndicator
slm?: HealthReportSlmIndicator slm?: HealthReportSlmIndicator
shards_capacity?: HealthReportShardsCapacityIndicator
} }
export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator { export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator {
@ -579,6 +580,20 @@ export interface HealthReportShardsAvailabilityIndicatorDetails {
unassigned_replicas: long unassigned_replicas: long
} }
export interface HealthReportShardsCapacityIndicator extends HealthReportBaseIndicator {
details?: HealthReportShardsCapacityIndicatorDetails
}
export interface HealthReportShardsCapacityIndicatorDetails {
data: HealthReportShardsCapacityIndicatorTierDetail
frozen: HealthReportShardsCapacityIndicatorTierDetail
}
export interface HealthReportShardsCapacityIndicatorTierDetail {
max_shards_in_cluster: integer
current_used_shards?: integer
}
export interface HealthReportSlmIndicator extends HealthReportBaseIndicator { export interface HealthReportSlmIndicator extends HealthReportBaseIndicator {
details?: HealthReportSlmIndicatorDetails details?: HealthReportSlmIndicatorDetails
} }
@ -8324,9 +8339,9 @@ export type ClusterExistsComponentTemplateResponse = boolean
export interface ClusterGetComponentTemplateRequest extends RequestBase { export interface ClusterGetComponentTemplateRequest extends RequestBase {
name?: Name name?: Name
flat_settings?: boolean flat_settings?: boolean
include_defaults?: boolean
local?: boolean local?: boolean
master_timeout?: Duration master_timeout?: Duration
include_defaults?: boolean
} }
export interface ClusterGetComponentTemplateResponse { export interface ClusterGetComponentTemplateResponse {
@ -8446,10 +8461,10 @@ export interface ClusterPutComponentTemplateRequest extends RequestBase {
name: Name name: Name
create?: boolean create?: boolean
master_timeout?: Duration master_timeout?: Duration
allow_auto_create?: boolean
template: IndicesIndexState template: IndicesIndexState
version?: VersionNumber version?: VersionNumber
_meta?: Metadata _meta?: Metadata
allow_auto_create?: boolean
} }
export type ClusterPutComponentTemplateResponse = AcknowledgedResponseBase export type ClusterPutComponentTemplateResponse = AcknowledgedResponseBase
@ -8584,14 +8599,14 @@ export interface ClusterStateRequest extends RequestBase {
export type ClusterStateResponse = any export type ClusterStateResponse = any
export interface ClusterStatsCharFilterTypes { export interface ClusterStatsCharFilterTypes {
char_filter_types: ClusterStatsFieldTypes[]
tokenizer_types: ClusterStatsFieldTypes[]
filter_types: ClusterStatsFieldTypes[]
analyzer_types: ClusterStatsFieldTypes[] analyzer_types: ClusterStatsFieldTypes[]
built_in_char_filters: ClusterStatsFieldTypes[]
built_in_tokenizers: ClusterStatsFieldTypes[]
built_in_filters: ClusterStatsFieldTypes[]
built_in_analyzers: ClusterStatsFieldTypes[] built_in_analyzers: ClusterStatsFieldTypes[]
built_in_char_filters: ClusterStatsFieldTypes[]
built_in_filters: ClusterStatsFieldTypes[]
built_in_tokenizers: ClusterStatsFieldTypes[]
char_filter_types: ClusterStatsFieldTypes[]
filter_types: ClusterStatsFieldTypes[]
tokenizer_types: ClusterStatsFieldTypes[]
} }
export interface ClusterStatsClusterFileSystem { export interface ClusterStatsClusterFileSystem {
@ -8601,6 +8616,7 @@ export interface ClusterStatsClusterFileSystem {
} }
export interface ClusterStatsClusterIndices { export interface ClusterStatsClusterIndices {
analysis: ClusterStatsCharFilterTypes
completion: CompletionStats completion: CompletionStats
count: long count: long
docs: DocStats docs: DocStats
@ -8610,7 +8626,6 @@ export interface ClusterStatsClusterIndices {
shards: ClusterStatsClusterIndicesShards shards: ClusterStatsClusterIndicesShards
store: StoreStats store: StoreStats
mappings: ClusterStatsFieldTypesMappings mappings: ClusterStatsFieldTypesMappings
analysis: ClusterStatsCharFilterTypes
versions?: ClusterStatsIndicesVersions[] versions?: ClusterStatsIndicesVersions[]
} }
@ -8662,24 +8677,25 @@ export interface ClusterStatsClusterNetworkTypes {
export interface ClusterStatsClusterNodeCount { export interface ClusterStatsClusterNodeCount {
coordinating_only: integer coordinating_only: integer
data: integer data: integer
data_cold: integer
data_content: integer
data_frozen?: integer
data_hot: integer
data_warm: integer
ingest: integer ingest: integer
master: integer master: integer
total: integer
voting_only: integer
data_cold: integer
data_frozen?: integer
data_content: integer
data_warm: integer
data_hot: integer
ml: integer ml: integer
remote_cluster_client: integer remote_cluster_client: integer
total: integer
transform: integer transform: integer
voting_only: integer
} }
export interface ClusterStatsClusterNodes { export interface ClusterStatsClusterNodes {
count: ClusterStatsClusterNodeCount count: ClusterStatsClusterNodeCount
discovery_types: Record<string, integer> discovery_types: Record<string, integer>
fs: ClusterStatsClusterFileSystem fs: ClusterStatsClusterFileSystem
indexing_pressure: ClusterStatsIndexingPressure
ingest: ClusterStatsClusterIngest ingest: ClusterStatsClusterIngest
jvm: ClusterStatsClusterJvm jvm: ClusterStatsClusterJvm
network_types: ClusterStatsClusterNetworkTypes network_types: ClusterStatsClusterNetworkTypes
@ -8688,21 +8704,20 @@ export interface ClusterStatsClusterNodes {
plugins: PluginStats[] plugins: PluginStats[]
process: ClusterStatsClusterProcess process: ClusterStatsClusterProcess
versions: VersionString[] versions: VersionString[]
indexing_pressure: ClusterStatsIndexingPressure
} }
export interface ClusterStatsClusterOperatingSystem { export interface ClusterStatsClusterOperatingSystem {
allocated_processors: integer allocated_processors: integer
architectures?: ClusterStatsClusterOperatingSystemArchitecture[]
available_processors: integer available_processors: integer
mem: ClusterStatsOperatingSystemMemoryInfo mem: ClusterStatsOperatingSystemMemoryInfo
names: ClusterStatsClusterOperatingSystemName[] names: ClusterStatsClusterOperatingSystemName[]
pretty_names: ClusterStatsClusterOperatingSystemPrettyName[] pretty_names: ClusterStatsClusterOperatingSystemPrettyName[]
architectures?: ClusterStatsClusterOperatingSystemArchitecture[]
} }
export interface ClusterStatsClusterOperatingSystemArchitecture { export interface ClusterStatsClusterOperatingSystemArchitecture {
count: integer
arch: string arch: string
count: integer
} }
export interface ClusterStatsClusterOperatingSystemName { export interface ClusterStatsClusterOperatingSystemName {
@ -8768,8 +8783,8 @@ export interface ClusterStatsIndexingPressure {
} }
export interface ClusterStatsIndexingPressureMemory { export interface ClusterStatsIndexingPressureMemory {
limit_in_bytes: long
current: ClusterStatsIndexingPressureMemorySummary current: ClusterStatsIndexingPressureMemorySummary
limit_in_bytes: long
total: ClusterStatsIndexingPressureMemorySummary total: ClusterStatsIndexingPressureMemorySummary
} }
@ -8798,12 +8813,12 @@ export interface ClusterStatsNodePackagingType {
} }
export interface ClusterStatsOperatingSystemMemoryInfo { export interface ClusterStatsOperatingSystemMemoryInfo {
adjusted_total_in_bytes?: long
free_in_bytes: long free_in_bytes: long
free_percent: integer free_percent: integer
total_in_bytes: long total_in_bytes: long
used_in_bytes: long used_in_bytes: long
used_percent: integer used_percent: integer
adjusted_total_in_bytes?: long
} }
export interface ClusterStatsRequest extends RequestBase { export interface ClusterStatsRequest extends RequestBase {
@ -8815,20 +8830,20 @@ export interface ClusterStatsRequest extends RequestBase {
export type ClusterStatsResponse = ClusterStatsStatsResponseBase export type ClusterStatsResponse = ClusterStatsStatsResponseBase
export interface ClusterStatsRuntimeFieldTypes { export interface ClusterStatsRuntimeFieldTypes {
name: Name chars_max: integer
chars_total: integer
count: integer count: integer
doc_max: integer
doc_total: integer
index_count: integer index_count: integer
scriptless_count: integer
shadowed_count: integer
lang: string[] lang: string[]
lines_max: integer lines_max: integer
lines_total: integer lines_total: integer
chars_max: integer name: Name
chars_total: integer scriptless_count: integer
shadowed_count: integer
source_max: integer source_max: integer
source_total: integer source_total: integer
doc_max: integer
doc_total: integer
} }
export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase { export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase {
@ -9453,19 +9468,19 @@ export interface IndicesDataLifecycleWithRollover {
} }
export interface IndicesDataStream { export interface IndicesDataStream {
name: DataStreamName
timestamp_field: IndicesDataStreamTimestampField
indices: IndicesDataStreamIndex[]
generation: integer
template: Name
hidden: boolean
replicated?: boolean
system?: boolean
status: HealthStatus
ilm_policy?: Name
_meta?: Metadata _meta?: Metadata
allow_custom_routing?: boolean allow_custom_routing?: boolean
generation: integer
hidden: boolean
ilm_policy?: Name
indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataLifecycleWithRollover
name: DataStreamName
replicated?: boolean
status: HealthStatus
system?: boolean
template: Name
timestamp_field: IndicesDataStreamTimestampField
} }
export interface IndicesDataStreamIndex { export interface IndicesDataStreamIndex {

View File

@ -538,6 +538,7 @@ export interface HealthReportIndicators {
repository_integrity?: HealthReportRepositoryIntegrityIndicator repository_integrity?: HealthReportRepositoryIntegrityIndicator
ilm?: HealthReportIlmIndicator ilm?: HealthReportIlmIndicator
slm?: HealthReportSlmIndicator slm?: HealthReportSlmIndicator
shards_capacity?: HealthReportShardsCapacityIndicator
} }
export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator { export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator {
@ -600,6 +601,20 @@ export interface HealthReportShardsAvailabilityIndicatorDetails {
unassigned_replicas: long unassigned_replicas: long
} }
export interface HealthReportShardsCapacityIndicator extends HealthReportBaseIndicator {
details?: HealthReportShardsCapacityIndicatorDetails
}
export interface HealthReportShardsCapacityIndicatorDetails {
data: HealthReportShardsCapacityIndicatorTierDetail
frozen: HealthReportShardsCapacityIndicatorTierDetail
}
export interface HealthReportShardsCapacityIndicatorTierDetail {
max_shards_in_cluster: integer
current_used_shards?: integer
}
export interface HealthReportSlmIndicator extends HealthReportBaseIndicator { export interface HealthReportSlmIndicator extends HealthReportBaseIndicator {
details?: HealthReportSlmIndicatorDetails details?: HealthReportSlmIndicatorDetails
} }
@ -8416,9 +8431,9 @@ export type ClusterExistsComponentTemplateResponse = boolean
export interface ClusterGetComponentTemplateRequest extends RequestBase { export interface ClusterGetComponentTemplateRequest extends RequestBase {
name?: Name name?: Name
flat_settings?: boolean flat_settings?: boolean
include_defaults?: boolean
local?: boolean local?: boolean
master_timeout?: Duration master_timeout?: Duration
include_defaults?: boolean
} }
export interface ClusterGetComponentTemplateResponse { export interface ClusterGetComponentTemplateResponse {
@ -8540,10 +8555,10 @@ export interface ClusterPutComponentTemplateRequest extends RequestBase {
master_timeout?: Duration master_timeout?: Duration
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: { body?: {
allow_auto_create?: boolean
template: IndicesIndexState template: IndicesIndexState
version?: VersionNumber version?: VersionNumber
_meta?: Metadata _meta?: Metadata
allow_auto_create?: boolean
} }
} }
@ -8685,14 +8700,14 @@ export interface ClusterStateRequest extends RequestBase {
export type ClusterStateResponse = any export type ClusterStateResponse = any
export interface ClusterStatsCharFilterTypes { export interface ClusterStatsCharFilterTypes {
char_filter_types: ClusterStatsFieldTypes[]
tokenizer_types: ClusterStatsFieldTypes[]
filter_types: ClusterStatsFieldTypes[]
analyzer_types: ClusterStatsFieldTypes[] analyzer_types: ClusterStatsFieldTypes[]
built_in_char_filters: ClusterStatsFieldTypes[]
built_in_tokenizers: ClusterStatsFieldTypes[]
built_in_filters: ClusterStatsFieldTypes[]
built_in_analyzers: ClusterStatsFieldTypes[] built_in_analyzers: ClusterStatsFieldTypes[]
built_in_char_filters: ClusterStatsFieldTypes[]
built_in_filters: ClusterStatsFieldTypes[]
built_in_tokenizers: ClusterStatsFieldTypes[]
char_filter_types: ClusterStatsFieldTypes[]
filter_types: ClusterStatsFieldTypes[]
tokenizer_types: ClusterStatsFieldTypes[]
} }
export interface ClusterStatsClusterFileSystem { export interface ClusterStatsClusterFileSystem {
@ -8702,6 +8717,7 @@ export interface ClusterStatsClusterFileSystem {
} }
export interface ClusterStatsClusterIndices { export interface ClusterStatsClusterIndices {
analysis: ClusterStatsCharFilterTypes
completion: CompletionStats completion: CompletionStats
count: long count: long
docs: DocStats docs: DocStats
@ -8711,7 +8727,6 @@ export interface ClusterStatsClusterIndices {
shards: ClusterStatsClusterIndicesShards shards: ClusterStatsClusterIndicesShards
store: StoreStats store: StoreStats
mappings: ClusterStatsFieldTypesMappings mappings: ClusterStatsFieldTypesMappings
analysis: ClusterStatsCharFilterTypes
versions?: ClusterStatsIndicesVersions[] versions?: ClusterStatsIndicesVersions[]
} }
@ -8763,24 +8778,25 @@ export interface ClusterStatsClusterNetworkTypes {
export interface ClusterStatsClusterNodeCount { export interface ClusterStatsClusterNodeCount {
coordinating_only: integer coordinating_only: integer
data: integer data: integer
data_cold: integer
data_content: integer
data_frozen?: integer
data_hot: integer
data_warm: integer
ingest: integer ingest: integer
master: integer master: integer
total: integer
voting_only: integer
data_cold: integer
data_frozen?: integer
data_content: integer
data_warm: integer
data_hot: integer
ml: integer ml: integer
remote_cluster_client: integer remote_cluster_client: integer
total: integer
transform: integer transform: integer
voting_only: integer
} }
export interface ClusterStatsClusterNodes { export interface ClusterStatsClusterNodes {
count: ClusterStatsClusterNodeCount count: ClusterStatsClusterNodeCount
discovery_types: Record<string, integer> discovery_types: Record<string, integer>
fs: ClusterStatsClusterFileSystem fs: ClusterStatsClusterFileSystem
indexing_pressure: ClusterStatsIndexingPressure
ingest: ClusterStatsClusterIngest ingest: ClusterStatsClusterIngest
jvm: ClusterStatsClusterJvm jvm: ClusterStatsClusterJvm
network_types: ClusterStatsClusterNetworkTypes network_types: ClusterStatsClusterNetworkTypes
@ -8789,21 +8805,20 @@ export interface ClusterStatsClusterNodes {
plugins: PluginStats[] plugins: PluginStats[]
process: ClusterStatsClusterProcess process: ClusterStatsClusterProcess
versions: VersionString[] versions: VersionString[]
indexing_pressure: ClusterStatsIndexingPressure
} }
export interface ClusterStatsClusterOperatingSystem { export interface ClusterStatsClusterOperatingSystem {
allocated_processors: integer allocated_processors: integer
architectures?: ClusterStatsClusterOperatingSystemArchitecture[]
available_processors: integer available_processors: integer
mem: ClusterStatsOperatingSystemMemoryInfo mem: ClusterStatsOperatingSystemMemoryInfo
names: ClusterStatsClusterOperatingSystemName[] names: ClusterStatsClusterOperatingSystemName[]
pretty_names: ClusterStatsClusterOperatingSystemPrettyName[] pretty_names: ClusterStatsClusterOperatingSystemPrettyName[]
architectures?: ClusterStatsClusterOperatingSystemArchitecture[]
} }
export interface ClusterStatsClusterOperatingSystemArchitecture { export interface ClusterStatsClusterOperatingSystemArchitecture {
count: integer
arch: string arch: string
count: integer
} }
export interface ClusterStatsClusterOperatingSystemName { export interface ClusterStatsClusterOperatingSystemName {
@ -8869,8 +8884,8 @@ export interface ClusterStatsIndexingPressure {
} }
export interface ClusterStatsIndexingPressureMemory { export interface ClusterStatsIndexingPressureMemory {
limit_in_bytes: long
current: ClusterStatsIndexingPressureMemorySummary current: ClusterStatsIndexingPressureMemorySummary
limit_in_bytes: long
total: ClusterStatsIndexingPressureMemorySummary total: ClusterStatsIndexingPressureMemorySummary
} }
@ -8899,12 +8914,12 @@ export interface ClusterStatsNodePackagingType {
} }
export interface ClusterStatsOperatingSystemMemoryInfo { export interface ClusterStatsOperatingSystemMemoryInfo {
adjusted_total_in_bytes?: long
free_in_bytes: long free_in_bytes: long
free_percent: integer free_percent: integer
total_in_bytes: long total_in_bytes: long
used_in_bytes: long used_in_bytes: long
used_percent: integer used_percent: integer
adjusted_total_in_bytes?: long
} }
export interface ClusterStatsRequest extends RequestBase { export interface ClusterStatsRequest extends RequestBase {
@ -8916,20 +8931,20 @@ export interface ClusterStatsRequest extends RequestBase {
export type ClusterStatsResponse = ClusterStatsStatsResponseBase export type ClusterStatsResponse = ClusterStatsStatsResponseBase
export interface ClusterStatsRuntimeFieldTypes { export interface ClusterStatsRuntimeFieldTypes {
name: Name chars_max: integer
chars_total: integer
count: integer count: integer
doc_max: integer
doc_total: integer
index_count: integer index_count: integer
scriptless_count: integer
shadowed_count: integer
lang: string[] lang: string[]
lines_max: integer lines_max: integer
lines_total: integer lines_total: integer
chars_max: integer name: Name
chars_total: integer scriptless_count: integer
shadowed_count: integer
source_max: integer source_max: integer
source_total: integer source_total: integer
doc_max: integer
doc_total: integer
} }
export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase { export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase {
@ -9576,19 +9591,19 @@ export interface IndicesDataLifecycleWithRollover {
} }
export interface IndicesDataStream { export interface IndicesDataStream {
name: DataStreamName
timestamp_field: IndicesDataStreamTimestampField
indices: IndicesDataStreamIndex[]
generation: integer
template: Name
hidden: boolean
replicated?: boolean
system?: boolean
status: HealthStatus
ilm_policy?: Name
_meta?: Metadata _meta?: Metadata
allow_custom_routing?: boolean allow_custom_routing?: boolean
generation: integer
hidden: boolean
ilm_policy?: Name
indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataLifecycleWithRollover
name: DataStreamName
replicated?: boolean
status: HealthStatus
system?: boolean
template: Name
timestamp_field: IndicesDataStreamTimestampField
} }
export interface IndicesDataStreamIndex { export interface IndicesDataStreamIndex {