diff --git a/specification/_global/bulk/BulkRequest.ts b/specification/_global/bulk/BulkRequest.ts index 40ceac41c1..39046a1513 100644 --- a/specification/_global/bulk/BulkRequest.ts +++ b/specification/_global/bulk/BulkRequest.ts @@ -31,6 +31,7 @@ import { OperationContainer, UpdateAction } from './types' /** * Bulk index or delete documents. + * * Perform multiple `index`, `create`, `delete`, and `update` actions in a single request. * This reduces overhead and can greatly increase indexing speed. * @@ -150,7 +151,6 @@ import { OperationContainer, UpdateAction } from './types' * @doc_id docs-bulk * @ext_doc_id indices-refresh-disable * @doc_tag document - * */ export interface Request extends RequestBase { urls: [ diff --git a/specification/_global/clear_scroll/ClearScrollRequest.ts b/specification/_global/clear_scroll/ClearScrollRequest.ts index 0ea0ad6cf5..7027fe496e 100644 --- a/specification/_global/clear_scroll/ClearScrollRequest.ts +++ b/specification/_global/clear_scroll/ClearScrollRequest.ts @@ -22,6 +22,7 @@ import { ScrollIds } from '@_types/common' /** * Clear a scrolling search. + * * Clear the search context and results for a scrolling search. * @rest_spec_name clear_scroll * @availability stack stability=stable diff --git a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts index 922650cead..0156c29866 100644 --- a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts +++ b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Close a point in time. + * * A point in time must be opened explicitly before being used in search requests. * The `keep_alive` parameter tells Elasticsearch how long it should persist. * A point in time is automatically closed when the `keep_alive` period has elapsed. diff --git a/specification/_global/count/CountRequest.ts b/specification/_global/count/CountRequest.ts index 76718b3284..a7545e84d7 100644 --- a/specification/_global/count/CountRequest.ts +++ b/specification/_global/count/CountRequest.ts @@ -30,6 +30,7 @@ import { Operator } from '@_types/query_dsl/Operator' /** * Count search results. + * * Get the number of documents matching a query. * * The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. diff --git a/specification/_global/delete_script/DeleteScriptRequest.ts b/specification/_global/delete_script/DeleteScriptRequest.ts index 586e1a29ae..b5f6e5545b 100644 --- a/specification/_global/delete_script/DeleteScriptRequest.ts +++ b/specification/_global/delete_script/DeleteScriptRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete a script or search template. + * * Deletes a stored script or search template. * @rest_spec_name delete_script * @availability stack stability=stable diff --git a/specification/_global/explain/ExplainRequest.ts b/specification/_global/explain/ExplainRequest.ts index 3e44fc21df..e55532ce6a 100644 --- a/specification/_global/explain/ExplainRequest.ts +++ b/specification/_global/explain/ExplainRequest.ts @@ -25,6 +25,7 @@ import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** * Explain a document match result. + * * Get information about why a specific document matches, or doesn't match, a query. * It computes a score explanation for a query and a specific document. * @rest_spec_name explain diff --git a/specification/_global/get_script/GetScriptRequest.ts b/specification/_global/get_script/GetScriptRequest.ts index ae747ad3a8..0f1d665b3a 100644 --- a/specification/_global/get_script/GetScriptRequest.ts +++ b/specification/_global/get_script/GetScriptRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get a script or search template. + * * Retrieves a stored script or search template. * @rest_spec_name get_script * @availability stack stability=stable diff --git a/specification/_global/health_report/Request.ts b/specification/_global/health_report/Request.ts index 50ba8b6816..7bae9ac0bd 100644 --- a/specification/_global/health_report/Request.ts +++ b/specification/_global/health_report/Request.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get the cluster health. + * * Get a report with the health status of an Elasticsearch cluster. * The report contains a list of indicators that compose Elasticsearch functionality. * diff --git a/specification/_global/info/RootNodeInfoRequest.ts b/specification/_global/info/RootNodeInfoRequest.ts index 5efb702c84..43d5a75ffb 100644 --- a/specification/_global/info/RootNodeInfoRequest.ts +++ b/specification/_global/info/RootNodeInfoRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get cluster info. + * * Get basic build, version, and cluster information. * ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored. * @rest_spec_name info diff --git a/specification/_global/ping/PingRequest.ts b/specification/_global/ping/PingRequest.ts index 5d6e45ac2f..47768f7aac 100644 --- a/specification/_global/ping/PingRequest.ts +++ b/specification/_global/ping/PingRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Ping the cluster. + * * Get information about whether the cluster is running. * @rest_spec_name ping * @availability stack stability=stable diff --git a/specification/_global/put_script/PutScriptRequest.ts b/specification/_global/put_script/PutScriptRequest.ts index d31a4420be..daf25adbaf 100644 --- a/specification/_global/put_script/PutScriptRequest.ts +++ b/specification/_global/put_script/PutScriptRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * Create or update a script or search template. + * * Creates or updates a stored script or search template. * @rest_spec_name put_script * @availability stack stability=stable diff --git a/specification/_global/search_template/SearchTemplateRequest.ts b/specification/_global/search_template/SearchTemplateRequest.ts index 3e23fa9f3b..e50e784834 100644 --- a/specification/_global/search_template/SearchTemplateRequest.ts +++ b/specification/_global/search_template/SearchTemplateRequest.ts @@ -33,6 +33,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Run a search with a search template. + * * @rest_spec_name search_template * @availability stack since=2.0.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/update_by_query/UpdateByQueryRequest.ts b/specification/_global/update_by_query/UpdateByQueryRequest.ts index ffabc80fce..92623faa4f 100644 --- a/specification/_global/update_by_query/UpdateByQueryRequest.ts +++ b/specification/_global/update_by_query/UpdateByQueryRequest.ts @@ -36,6 +36,7 @@ import { Duration } from '@_types/Time' /** * Update documents. + * * Updates documents that match the specified query. * If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. * diff --git a/specification/ccr/follow/CreateFollowIndexRequest.ts b/specification/ccr/follow/CreateFollowIndexRequest.ts index 9b28d5c35a..4c99cc4805 100644 --- a/specification/ccr/follow/CreateFollowIndexRequest.ts +++ b/specification/ccr/follow/CreateFollowIndexRequest.ts @@ -25,6 +25,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings' /** * Create a follower. + * * Create a cross-cluster replication follower index that follows a specific leader index. * When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. * @rest_spec_name ccr.follow diff --git a/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts index 3ce2b2f7c3..55a16f1da2 100644 --- a/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts +++ b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Forget a follower. + * * Remove the cross-cluster replication follower retention leases from the leader. * * A following index takes out retention leases on its leader index. diff --git a/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts b/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts index 3adc5098ad..05b105494f 100644 --- a/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts +++ b/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts @@ -26,6 +26,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Create or update auto-follow patterns. + * * Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. * Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. * Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. diff --git a/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts index cc8c196c6c..54e3e7c929 100644 --- a/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts +++ b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * Resume a follower. + * * Resume a cross-cluster replication follower index that was paused. * The follower index could have been paused with the pause follower API. * Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. diff --git a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts index d70c3a847a..ebb6a36095 100644 --- a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts +++ b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * Explain the shard allocations. + * * Get explanations for shard allocations in the cluster. * This API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time. * For unassigned shards, it provides an explanation for why the shard is unassigned. diff --git a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts index cdead961a5..ee8be7197e 100644 --- a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts +++ b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete component templates. + * * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. * @rest_spec_name cluster.delete_component_template * @availability stack since=7.8.0 stability=stable diff --git a/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts b/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts index e2d068f999..efcaa43104 100644 --- a/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts +++ b/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Clear cluster voting config exclusions. + * * Remove master-eligible nodes from the voting configuration exclusion list. * @rest_spec_name cluster.delete_voting_config_exclusions * @availability stack since=7.0.0 stability=stable diff --git a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts index 413567e5a3..d1de6f7fc9 100644 --- a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts +++ b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Check component templates. + * * Returns information about whether a particular component template exists. * @rest_spec_name cluster.exists_component_template * @availability stack since=7.8.0 stability=stable diff --git a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts index aff980511b..fc61458df3 100644 --- a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts +++ b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get component templates. + * * Get information about component templates. * @rest_spec_name cluster.get_component_template * @availability stack since=7.8.0 stability=stable diff --git a/specification/cluster/info/ClusterInfoRequest.ts b/specification/cluster/info/ClusterInfoRequest.ts index 9d49cbf9ea..8753913bd3 100644 --- a/specification/cluster/info/ClusterInfoRequest.ts +++ b/specification/cluster/info/ClusterInfoRequest.ts @@ -22,6 +22,7 @@ import { ClusterInfoTargets } from '@_types/common' /** * Get cluster info. + * * Returns basic information about the cluster. * @rest_spec_name cluster.info * @availability stack since=8.9.0 stability=stable diff --git a/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts b/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts index 6e026fa9d3..d0d12c89ef 100644 --- a/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts +++ b/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get the pending cluster tasks. + * * Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. * * NOTE: This API returns a list of any pending updates to the cluster state. diff --git a/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts b/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts index 7076174eef..3b9a746ec6 100644 --- a/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts +++ b/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Update voting configuration exclusions. + * * Update the cluster voting config exclusions by node IDs or node names. * By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. * If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. diff --git a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts index 4701e5cadb..1095dcfd44 100644 --- a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts +++ b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts @@ -24,6 +24,7 @@ import { IndexState } from '@indices/_types/IndexState' /** * Create or update a component template. + * * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. * * An index template can be composed of multiple component templates. diff --git a/specification/cluster/reroute/ClusterRerouteRequest.ts b/specification/cluster/reroute/ClusterRerouteRequest.ts index e353fc9f1f..bca9d4a3bb 100644 --- a/specification/cluster/reroute/ClusterRerouteRequest.ts +++ b/specification/cluster/reroute/ClusterRerouteRequest.ts @@ -23,6 +23,7 @@ import { Command } from './types' /** * Reroute the cluster. + * * Manually change the allocation of individual shards in the cluster. * For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node. * diff --git a/specification/cluster/state/ClusterStateRequest.ts b/specification/cluster/state/ClusterStateRequest.ts index 13d03e552f..69dc7033d8 100644 --- a/specification/cluster/state/ClusterStateRequest.ts +++ b/specification/cluster/state/ClusterStateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get the cluster state. + * * Get comprehensive information about the state of the cluster. * * The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster. diff --git a/specification/cluster/stats/ClusterStatsRequest.ts b/specification/cluster/stats/ClusterStatsRequest.ts index c2d97881f6..ac8d40db01 100644 --- a/specification/cluster/stats/ClusterStatsRequest.ts +++ b/specification/cluster/stats/ClusterStatsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get cluster statistics. + * * Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). * @rest_spec_name cluster.stats * @availability stack since=1.3.0 stability=stable diff --git a/specification/connector/put/ConnectorPutRequest.ts b/specification/connector/put/ConnectorPutRequest.ts index ae4dfe35dd..ebe90475b1 100644 --- a/specification/connector/put/ConnectorPutRequest.ts +++ b/specification/connector/put/ConnectorPutRequest.ts @@ -21,6 +21,7 @@ import { Id, IndexName } from '@_types/common' /** * Create or update a connector. + * * @rest_spec_name connector.put * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/sync_job_check_in/SyncJobCheckInRequest.ts b/specification/connector/sync_job_check_in/SyncJobCheckInRequest.ts index e7d89d943b..dc4b4141cb 100644 --- a/specification/connector/sync_job_check_in/SyncJobCheckInRequest.ts +++ b/specification/connector/sync_job_check_in/SyncJobCheckInRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Check in a connector sync job. + * * Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. * * To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. diff --git a/specification/connector/sync_job_claim/SyncJobClaimRequest.ts b/specification/connector/sync_job_claim/SyncJobClaimRequest.ts index 2de2b9b622..e4a84dd323 100644 --- a/specification/connector/sync_job_claim/SyncJobClaimRequest.ts +++ b/specification/connector/sync_job_claim/SyncJobClaimRequest.ts @@ -22,6 +22,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Claim a connector sync job. + * * This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. * Additionally, it can set the `sync_cursor` property for the sync job. * diff --git a/specification/connector/sync_job_error/SyncJobErrorRequest.ts b/specification/connector/sync_job_error/SyncJobErrorRequest.ts index c18e913449..ab677cf91d 100644 --- a/specification/connector/sync_job_error/SyncJobErrorRequest.ts +++ b/specification/connector/sync_job_error/SyncJobErrorRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Set a connector sync job error. + * * Set the `error` field for a connector sync job and set its `status` to `error`. * * To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. diff --git a/specification/connector/sync_job_get/SyncJobGetRequest.ts b/specification/connector/sync_job_get/SyncJobGetRequest.ts index c3ccecf86e..dd0c25ce93 100644 --- a/specification/connector/sync_job_get/SyncJobGetRequest.ts +++ b/specification/connector/sync_job_get/SyncJobGetRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Get a connector sync job. + * * @rest_spec_name connector.sync_job_get * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/sync_job_update_stats/SyncJobUpdateStatsRequest.ts b/specification/connector/sync_job_update_stats/SyncJobUpdateStatsRequest.ts index 4b1f05b57f..a1971db1aa 100644 --- a/specification/connector/sync_job_update_stats/SyncJobUpdateStatsRequest.ts +++ b/specification/connector/sync_job_update_stats/SyncJobUpdateStatsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Set the connector sync job stats. + * * Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. * You can also update `last_seen`. * This API is mainly used by the connector service for updating sync job information. diff --git a/specification/connector/update_features/ConnectorUpdateFeaturesRequest.ts b/specification/connector/update_features/ConnectorUpdateFeaturesRequest.ts index e575f0ba2f..48c5d23b0a 100644 --- a/specification/connector/update_features/ConnectorUpdateFeaturesRequest.ts +++ b/specification/connector/update_features/ConnectorUpdateFeaturesRequest.ts @@ -22,6 +22,7 @@ import { ConnectorFeatures } from '../_types/Connector' /** * Update the connector features. + * * Update the connector features in the connector document. * This API can be used to control the following aspects of a connector: * diff --git a/specification/connector/update_name/ConnectorUpdateNameRequest.ts b/specification/connector/update_name/ConnectorUpdateNameRequest.ts index 18d4e902e2..b2acdf73a8 100644 --- a/specification/connector/update_name/ConnectorUpdateNameRequest.ts +++ b/specification/connector/update_name/ConnectorUpdateNameRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Update the connector name and description. + * * @rest_spec_name connector.update_name * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_native/ConnectorUpdateNativeRequest.ts b/specification/connector/update_native/ConnectorUpdateNativeRequest.ts index 126bad1357..ec1f53b7e1 100644 --- a/specification/connector/update_native/ConnectorUpdateNativeRequest.ts +++ b/specification/connector/update_native/ConnectorUpdateNativeRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Update the connector is_native flag. + * * @rest_spec_name connector.update_native * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts b/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts index 1b061b13d9..50853ee9d6 100644 --- a/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts +++ b/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts @@ -22,6 +22,7 @@ import { SchedulingConfiguration } from '../_types/Connector' /** * Update the connector scheduling. + * * @rest_spec_name connector.update_scheduling * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts b/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts index ca7f7cec4e..4b6a5e8090 100644 --- a/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts +++ b/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Update the connector service type. + * * @rest_spec_name connector.update_service_type * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_status/ConnectorUpdateStatusRequest.ts b/specification/connector/update_status/ConnectorUpdateStatusRequest.ts index f47f5b726b..e747f2e645 100644 --- a/specification/connector/update_status/ConnectorUpdateStatusRequest.ts +++ b/specification/connector/update_status/ConnectorUpdateStatusRequest.ts @@ -22,6 +22,7 @@ import { ConnectorStatus } from '../_types/Connector' /** * Update the connector status. + * * @rest_spec_name connector.update_status * @availability stack since=8.12.0 stability=experimental * @availability serverless stability=experimental visibility=public diff --git a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts index 437981b53e..119704ce6c 100644 --- a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts +++ b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete a dangling index. + * * If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. * For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. * @rest_spec_name dangling_indices.delete_dangling_index diff --git a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts index 9f2ef71295..7e04dee1ea 100644 --- a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts +++ b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete an enrich policy. + * * Deletes an existing enrich policy and its enrich index. * @rest_spec_name enrich.delete_policy * @availability stack since=7.5.0 stability=stable diff --git a/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts b/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts index 68a85f6a7a..d91261951f 100644 --- a/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts +++ b/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Run an enrich policy. + * * Create the enrich index for an existing enrich policy. * @doc_id execute-enrich-policy-api * @rest_spec_name enrich.execute_policy diff --git a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts index 361c662662..9dee9ee918 100644 --- a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts +++ b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get an enrich policy. + * * Returns information about an enrich policy. * @rest_spec_name enrich.get_policy * @availability stack since=7.5.0 stability=stable diff --git a/specification/enrich/put_policy/PutEnrichPolicyRequest.ts b/specification/enrich/put_policy/PutEnrichPolicyRequest.ts index cd62e0b1da..304fef9d83 100644 --- a/specification/enrich/put_policy/PutEnrichPolicyRequest.ts +++ b/specification/enrich/put_policy/PutEnrichPolicyRequest.ts @@ -24,6 +24,7 @@ import { Policy } from '@enrich/_types/Policy' /** * Create an enrich policy. + * * Creates an enrich policy. * @doc_id put-enrich-policy-api * @rest_spec_name enrich.put_policy diff --git a/specification/enrich/stats/EnrichStatsRequest.ts b/specification/enrich/stats/EnrichStatsRequest.ts index 384b86f69d..8b44e2c433 100644 --- a/specification/enrich/stats/EnrichStatsRequest.ts +++ b/specification/enrich/stats/EnrichStatsRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get enrich stats. + * * Returns enrich coordinator statistics and information about enrich policies that are currently executing. * @rest_spec_name enrich.stats * @availability stack since=7.5.0 stability=stable diff --git a/specification/eql/delete/EqlDeleteRequest.ts b/specification/eql/delete/EqlDeleteRequest.ts index aeb140631c..5aadfb4f51 100644 --- a/specification/eql/delete/EqlDeleteRequest.ts +++ b/specification/eql/delete/EqlDeleteRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete an async EQL search. + * * Delete an async EQL search or a stored synchronous EQL search. * The API also deletes results for the search. * @rest_spec_name eql.delete diff --git a/specification/eql/get/EqlGetRequest.ts b/specification/eql/get/EqlGetRequest.ts index ba5fb258ce..3145181824 100644 --- a/specification/eql/get/EqlGetRequest.ts +++ b/specification/eql/get/EqlGetRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get async EQL search results. + * * Get the current status and available results for an async EQL search or a stored synchronous EQL search. * @doc_id eql-async-search-api * @rest_spec_name eql.get diff --git a/specification/eql/get_status/EqlGetStatusRequest.ts b/specification/eql/get_status/EqlGetStatusRequest.ts index 4867b14dc4..0ab6b78a7c 100644 --- a/specification/eql/get_status/EqlGetStatusRequest.ts +++ b/specification/eql/get_status/EqlGetStatusRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Get the async EQL status. + * * Get the current status for an async EQL search or a stored synchronous EQL search without returning results. * @doc_id eql-async-search-status-api * @rest_spec_name eql.get_status diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts index 50982d142f..bf661120bf 100644 --- a/specification/eql/search/EqlSearchRequest.ts +++ b/specification/eql/search/EqlSearchRequest.ts @@ -27,6 +27,7 @@ import { ResultPosition } from './types' /** * Get EQL search results. + * * Returns search results for an Event Query Language (EQL) query. * EQL assumes each document in a data stream or index corresponds to an event. * @rest_spec_name eql.search diff --git a/specification/eslint.config.js b/specification/eslint.config.js index cf921da0f4..36aa810de6 100644 --- a/specification/eslint.config.js +++ b/specification/eslint.config.js @@ -95,6 +95,27 @@ export default defineConfig({ } } ], - 'es-spec-validator/no-all-string-literal-unions': 'error' + 'es-spec-validator/no-all-string-literal-unions': 'error', + 'es-spec-validator/jsdoc-endpoint-check': [ + 'error', + { + markdownlint: { + default: true, + MD041: false, // first-line-heading + MD013: false, // line-length + MD033: false, // no-inline-html + MD034: false, // no-bare-urls + MD047: false, // single-trailing-newline + MD036: false, // no-emphasis-as-heading + MD040: false, // fenced-code-language + MD032: false, // blanks-around-lists + MD031: false, // blanks-around-fences + MD038: false, // no-space-in-code + MD060: false, // table-column-style + MD010: false, // no-hard-tabs + MD022: false // blanks-around-headers + } + } + ] } }) diff --git a/specification/esql/async_query/AsyncQueryRequest.ts b/specification/esql/async_query/AsyncQueryRequest.ts index 4f552ca877..5bccdf15e2 100644 --- a/specification/esql/async_query/AsyncQueryRequest.ts +++ b/specification/esql/async_query/AsyncQueryRequest.ts @@ -27,6 +27,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Run an async ES|QL query. + * * Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available. * * The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties. diff --git a/specification/esql/async_query_delete/AsyncQueryDeleteRequest.ts b/specification/esql/async_query_delete/AsyncQueryDeleteRequest.ts index cdc742a763..c83d84d4c9 100644 --- a/specification/esql/async_query_delete/AsyncQueryDeleteRequest.ts +++ b/specification/esql/async_query_delete/AsyncQueryDeleteRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete an async ES|QL query. + * * If the query is still running, it is cancelled. * Otherwise, the stored results are deleted. * diff --git a/specification/esql/async_query_get/AsyncQueryGetRequest.ts b/specification/esql/async_query_get/AsyncQueryGetRequest.ts index 3c96b7aaaf..1bb8f2b95b 100644 --- a/specification/esql/async_query_get/AsyncQueryGetRequest.ts +++ b/specification/esql/async_query_get/AsyncQueryGetRequest.ts @@ -24,6 +24,7 @@ import { EsqlFormat } from '@esql/_types/QueryParameters' /** * Get async ES|QL query results. + * * Get the current status and available results or stored results for an ES|QL asynchronous query. * If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API. * @rest_spec_name esql.async_query_get diff --git a/specification/esql/get_query/GetQueryRequest.ts b/specification/esql/get_query/GetQueryRequest.ts index 6242553a88..995e218506 100644 --- a/specification/esql/get_query/GetQueryRequest.ts +++ b/specification/esql/get_query/GetQueryRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Get a specific running ES|QL query information. + * * Returns an object extended information about a running ES|QL query. * * @rest_spec_name esql.get_query diff --git a/specification/esql/list_queries/ListQueriesRequest.ts b/specification/esql/list_queries/ListQueriesRequest.ts index 06c353f4dd..a3d29b572b 100644 --- a/specification/esql/list_queries/ListQueriesRequest.ts +++ b/specification/esql/list_queries/ListQueriesRequest.ts @@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base' /** * Get running ES|QL queries information. + * * Returns an object containing IDs and other information about the running ES|QL queries. - + * * @rest_spec_name esql.list_queries * @cluster_privileges monitor_esql * @availability stack since=9.1.0 stability=experimental visibility=public diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts index 0e22f2d9fe..84c828942d 100644 --- a/specification/esql/query/QueryRequest.ts +++ b/specification/esql/query/QueryRequest.ts @@ -26,6 +26,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Run an ES|QL query. + * * Get search results for an ES|QL (Elasticsearch query language) query. * @rest_spec_name esql.query * @availability stack since=8.11.0 diff --git a/specification/features/get_features/GetFeaturesRequest.ts b/specification/features/get_features/GetFeaturesRequest.ts index 3e85c362b3..d5495a19b5 100644 --- a/specification/features/get_features/GetFeaturesRequest.ts +++ b/specification/features/get_features/GetFeaturesRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get the features. + * * Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. * You can use this API to determine which feature states to include when taking a snapshot. * By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. diff --git a/specification/features/reset_features/ResetFeaturesRequest.ts b/specification/features/reset_features/ResetFeaturesRequest.ts index 41d2414330..c0ef6a55ee 100644 --- a/specification/features/reset_features/ResetFeaturesRequest.ts +++ b/specification/features/reset_features/ResetFeaturesRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Reset the features. + * * Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. * * WARNING: Intended for development and testing use only. Do not reset features on a production cluster. diff --git a/specification/fleet/msearch/MultiSearchRequest.ts b/specification/fleet/msearch/MultiSearchRequest.ts index 2820ead05e..38ab40aa32 100644 --- a/specification/fleet/msearch/MultiSearchRequest.ts +++ b/specification/fleet/msearch/MultiSearchRequest.ts @@ -30,6 +30,7 @@ import { Checkpoint } from '../_types/Checkpoints' /** * Run multiple Fleet searches. + * * Run several Fleet searches with a single API request. * The API follows the same structure as the multi search API. * However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. diff --git a/specification/fleet/search/SearchRequest.ts b/specification/fleet/search/SearchRequest.ts index a913986105..2b809d0fd0 100644 --- a/specification/fleet/search/SearchRequest.ts +++ b/specification/fleet/search/SearchRequest.ts @@ -53,6 +53,7 @@ import { Checkpoint } from '../_types/Checkpoints' /** * Run a Fleet search. + * * The purpose of the Fleet search API is to provide an API where the search will be run only * after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. * @rest_spec_name fleet.search diff --git a/specification/graph/explore/GraphExploreRequest.ts b/specification/graph/explore/GraphExploreRequest.ts index 2006f12ed6..89cab2147b 100644 --- a/specification/graph/explore/GraphExploreRequest.ts +++ b/specification/graph/explore/GraphExploreRequest.ts @@ -27,6 +27,7 @@ import { Hop } from '../_types/Hop' /** * Explore graph analytics. + * * Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. * The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. * An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. diff --git a/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts b/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts index 17e2be2796..8686f06b32 100644 --- a/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts +++ b/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete a lifecycle policy. + * * You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. * @rest_spec_name ilm.delete_lifecycle * @availability stack since=6.6.0 stability=stable diff --git a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts index e38ef3aaf8..d901bafa2f 100644 --- a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts +++ b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Explain the lifecycle state. + * * Get the current lifecycle status for one or more indices. * For data streams, the API retrieves the current lifecycle status for the stream's backing indices. * diff --git a/specification/ilm/get_lifecycle/GetLifecycleRequest.ts b/specification/ilm/get_lifecycle/GetLifecycleRequest.ts index a374e348ea..dce9b91d44 100644 --- a/specification/ilm/get_lifecycle/GetLifecycleRequest.ts +++ b/specification/ilm/get_lifecycle/GetLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get lifecycle policies. + * * @rest_spec_name ilm.get_lifecycle * @availability stack since=6.6.0 stability=stable * @cluster_privileges manage_ilm, read_ilm diff --git a/specification/ilm/migrate_to_data_tiers/Request.ts b/specification/ilm/migrate_to_data_tiers/Request.ts index 0b6fa2e189..49ec77e370 100644 --- a/specification/ilm/migrate_to_data_tiers/Request.ts +++ b/specification/ilm/migrate_to_data_tiers/Request.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Migrate to data tiers routing. + * * Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. * Optionally, delete one legacy index template. * Using node roles enables ILM to automatically move the indices between data tiers. diff --git a/specification/ilm/move_to_step/MoveToStepRequest.ts b/specification/ilm/move_to_step/MoveToStepRequest.ts index 387d769b0e..fe5c89802e 100644 --- a/specification/ilm/move_to_step/MoveToStepRequest.ts +++ b/specification/ilm/move_to_step/MoveToStepRequest.ts @@ -23,6 +23,7 @@ import { StepKey } from './types' /** * Move to a lifecycle step. + * * Manually move an index into a specific step in the lifecycle policy and run that step. * * WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. diff --git a/specification/ilm/put_lifecycle/PutLifecycleRequest.ts b/specification/ilm/put_lifecycle/PutLifecycleRequest.ts index ce5071d87e..9e5006feac 100644 --- a/specification/ilm/put_lifecycle/PutLifecycleRequest.ts +++ b/specification/ilm/put_lifecycle/PutLifecycleRequest.ts @@ -24,6 +24,7 @@ import { Policy } from '@ilm/_types/Policy' /** * Create or update a lifecycle policy. + * * If the specified policy exists, it is replaced and the policy version is incremented. * * NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. diff --git a/specification/ilm/remove_policy/RemovePolicyRequest.ts b/specification/ilm/remove_policy/RemovePolicyRequest.ts index 9e2181480a..9fd35b78c9 100644 --- a/specification/ilm/remove_policy/RemovePolicyRequest.ts +++ b/specification/ilm/remove_policy/RemovePolicyRequest.ts @@ -22,6 +22,7 @@ import { IndexName } from '@_types/common' /** * Remove policies from an index. + * * Remove the assigned lifecycle policies from an index or a data stream's backing indices. * It also stops managing the indices. * @rest_spec_name ilm.remove_policy diff --git a/specification/ilm/retry/RetryIlmRequest.ts b/specification/ilm/retry/RetryIlmRequest.ts index c08af01285..67c6d7340d 100644 --- a/specification/ilm/retry/RetryIlmRequest.ts +++ b/specification/ilm/retry/RetryIlmRequest.ts @@ -22,6 +22,7 @@ import { IndexName } from '@_types/common' /** * Retry a policy. + * * Retry running the lifecycle policy for an index that is in the ERROR step. * The API sets the policy back to the step where the error occurred and runs the step. * Use the explain lifecycle state API to determine whether an index is in the ERROR step. diff --git a/specification/ilm/start/StartIlmRequest.ts b/specification/ilm/start/StartIlmRequest.ts index 0f57107f14..a8928bf600 100644 --- a/specification/ilm/start/StartIlmRequest.ts +++ b/specification/ilm/start/StartIlmRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Start the ILM plugin. + * * Start the index lifecycle management plugin if it is currently stopped. * ILM is started automatically when the cluster is formed. * Restarting ILM is necessary only when it has been stopped using the stop ILM API. diff --git a/specification/ilm/stop/StopIlmRequest.ts b/specification/ilm/stop/StopIlmRequest.ts index 6aa89ec787..1d182ef4a8 100644 --- a/specification/ilm/stop/StopIlmRequest.ts +++ b/specification/ilm/stop/StopIlmRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Stop the ILM plugin. + * * Halt all lifecycle management operations and stop the index lifecycle management plugin. * This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. * diff --git a/specification/indices/analyze/IndicesAnalyzeRequest.ts b/specification/indices/analyze/IndicesAnalyzeRequest.ts index d04cfba83f..6d65ab20e9 100644 --- a/specification/indices/analyze/IndicesAnalyzeRequest.ts +++ b/specification/indices/analyze/IndicesAnalyzeRequest.ts @@ -26,6 +26,7 @@ import { TextToAnalyze } from './types' /** * Get tokens from text analysis. + * * The analyze API performs analysis on a text string and returns the resulting tokens. * * Generating excessive amount of tokens may cause a node to run out of memory. diff --git a/specification/indices/clear_cache/IndicesClearCacheRequest.ts b/specification/indices/clear_cache/IndicesClearCacheRequest.ts index b740c3b851..25533ad895 100644 --- a/specification/indices/clear_cache/IndicesClearCacheRequest.ts +++ b/specification/indices/clear_cache/IndicesClearCacheRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Fields, Indices } from '@_types/common' /** * Clear the cache. + * * Clear the cache of one or more indices. * For data streams, the API clears the caches of the stream's backing indices. * diff --git a/specification/indices/clone/IndicesCloneRequest.ts b/specification/indices/clone/IndicesCloneRequest.ts index 0a9c9d11b2..9d0f5ef9ed 100644 --- a/specification/indices/clone/IndicesCloneRequest.ts +++ b/specification/indices/clone/IndicesCloneRequest.ts @@ -26,6 +26,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Clone an index. + * * Clone an existing index into a new index. * Each original primary shard is cloned into a new primary shard in the new index. * diff --git a/specification/indices/close/CloseIndexRequest.ts b/specification/indices/close/CloseIndexRequest.ts index e0384ac852..fb33c16343 100644 --- a/specification/indices/close/CloseIndexRequest.ts +++ b/specification/indices/close/CloseIndexRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Close an index. + * * A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. * It is not possible to index documents or to search for documents in a closed index. * Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. diff --git a/specification/indices/create/IndicesCreateRequest.ts b/specification/indices/create/IndicesCreateRequest.ts index 4e51f2e621..40b72ed982 100644 --- a/specification/indices/create/IndicesCreateRequest.ts +++ b/specification/indices/create/IndicesCreateRequest.ts @@ -27,6 +27,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Create an index. + * * You can use the create index API to add a new index to an Elasticsearch cluster. * When creating an index, you can specify the following: * diff --git a/specification/indices/delete/IndicesDeleteRequest.ts b/specification/indices/delete/IndicesDeleteRequest.ts index b2a93c570b..c47b403e83 100644 --- a/specification/indices/delete/IndicesDeleteRequest.ts +++ b/specification/indices/delete/IndicesDeleteRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete indices. + * * Deleting an index deletes its documents, shards, and metadata. * It does not delete related Kibana components, such as data views, visualizations, or dashboards. * diff --git a/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts b/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts index 26182b0c00..e042f08e5f 100644 --- a/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts +++ b/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete an alias. + * * Removes a data stream or index from an alias. * @rest_spec_name indices.delete_alias * @availability stack stability=stable diff --git a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts index fe4c72e305..6529e29c1c 100644 --- a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts +++ b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete data stream lifecycles. + * * Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. * @rest_spec_name indices.delete_data_lifecycle * @availability stack since=8.11.0 stability=stable diff --git a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts index 8ae3d9ac38..d21759a717 100644 --- a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts +++ b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete data streams. + * * Deletes one or more data streams and their backing indices. * @rest_spec_name indices.delete_data_stream * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts index e133bb60b2..3815320b39 100644 --- a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts +++ b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete data stream options. + * * Removes the data stream options from a data stream. * @rest_spec_name indices.delete_data_stream_options * @availability stack since=8.19.0 stability=stable diff --git a/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts b/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts index b35a35e0ca..c1404f53a9 100644 --- a/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts +++ b/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete an index template. + * * The provided may contain multiple template names separated by a comma. If multiple template * names are specified then there is no wildcard support and the provided names should match completely with * existing templates. diff --git a/specification/indices/delete_sample_configuration/IndicesDeleteSampleConfigurationRequest.ts b/specification/indices/delete_sample_configuration/IndicesDeleteSampleConfigurationRequest.ts index f3c0b733db..a66ae17f05 100644 --- a/specification/indices/delete_sample_configuration/IndicesDeleteSampleConfigurationRequest.ts +++ b/specification/indices/delete_sample_configuration/IndicesDeleteSampleConfigurationRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete sampling configuration. + * * Delete the sampling configuration for the specified index. * @rest_spec_name indices.delete_sample_configuration * @availability stack visibility=feature_flag feature_flag=random_sampling since=9.3.0 stability=experimental diff --git a/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts b/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts index baa1a10e63..54674089f7 100644 --- a/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts +++ b/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete a legacy index template. + * * IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. * @rest_spec_name indices.delete_template * @availability stack stability=stable diff --git a/specification/indices/disk_usage/IndicesDiskUsageRequest.ts b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts index 3bce58ff15..31ebeb931c 100644 --- a/specification/indices/disk_usage/IndicesDiskUsageRequest.ts +++ b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Analyze the index disk usage. + * * Analyze the disk usage of each field of an index or data stream. * This API might not support indices created in previous Elasticsearch versions. * The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. diff --git a/specification/indices/downsample/Request.ts b/specification/indices/downsample/Request.ts index 5fed5390a2..50f6fe15e6 100644 --- a/specification/indices/downsample/Request.ts +++ b/specification/indices/downsample/Request.ts @@ -23,6 +23,7 @@ import { DownsampleConfig } from '@indices/_types/Downsample' /** * Downsample an index. + * * Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics: * * - When running in `aggregate` mode, it pre-calculates and stores statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) diff --git a/specification/indices/exists/IndicesExistsRequest.ts b/specification/indices/exists/IndicesExistsRequest.ts index 545f2005bf..3d0c2fdbfc 100644 --- a/specification/indices/exists/IndicesExistsRequest.ts +++ b/specification/indices/exists/IndicesExistsRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Check indices. + * * Check if one or more indices, index aliases, or data streams exist. * @rest_spec_name indices.exists * @availability stack stability=stable diff --git a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts index 73e9858d6b..98bd92c2b2 100644 --- a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts +++ b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Check existence of index templates. + * * Get information about whether index templates exist. * Index templates define settings, mappings, and aliases that can be applied automatically to new indices. * diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts index 0b893a628a..f2904a0993 100644 --- a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts +++ b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get the status for a data stream lifecycle. + * * Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. * @rest_spec_name indices.explain_data_lifecycle * @availability stack since=8.11.0 stability=stable diff --git a/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts b/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts index dac6f9f1ce..1155b6fa56 100644 --- a/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts +++ b/specification/indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Fields, Indices } from '@_types/common' /** * Get field usage stats. + * * Get field usage information for each shard and field of an index. * Field usage statistics are automatically captured when queries are running on a cluster. * A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. diff --git a/specification/indices/flush/IndicesFlushRequest.ts b/specification/indices/flush/IndicesFlushRequest.ts index 8101115d40..9998974df2 100644 --- a/specification/indices/flush/IndicesFlushRequest.ts +++ b/specification/indices/flush/IndicesFlushRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Flush data streams or indices. + * * Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. * When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. * Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. diff --git a/specification/indices/forcemerge/IndicesForceMergeRequest.ts b/specification/indices/forcemerge/IndicesForceMergeRequest.ts index 108db6fe4f..708302f587 100644 --- a/specification/indices/forcemerge/IndicesForceMergeRequest.ts +++ b/specification/indices/forcemerge/IndicesForceMergeRequest.ts @@ -23,6 +23,7 @@ import { long } from '@_types/Numeric' /** * Force a merge. + * * Perform the force merge operation on the shards of one or more indices. * For data streams, the API forces a merge on the shards of the stream's backing indices. * diff --git a/specification/indices/get/IndicesGetRequest.ts b/specification/indices/get/IndicesGetRequest.ts index 4a25de881e..9b39615e40 100644 --- a/specification/indices/get/IndicesGetRequest.ts +++ b/specification/indices/get/IndicesGetRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get index information. + * * Get information about one or more indices. For data streams, the API returns information about the * stream’s backing indices. * @rest_spec_name indices.get diff --git a/specification/indices/get_alias/IndicesGetAliasRequest.ts b/specification/indices/get_alias/IndicesGetAliasRequest.ts index 79b7833ca2..6a4e93ea59 100644 --- a/specification/indices/get_alias/IndicesGetAliasRequest.ts +++ b/specification/indices/get_alias/IndicesGetAliasRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get aliases. + * * Retrieves information for one or more data stream or index aliases. * @rest_spec_name indices.get_alias * @availability stack stability=stable diff --git a/specification/indices/get_all_sample_configuration/IndicesGetAllSampleConfigurationRequest.ts b/specification/indices/get_all_sample_configuration/IndicesGetAllSampleConfigurationRequest.ts index 67fb38bb1b..d73cb24f1c 100644 --- a/specification/indices/get_all_sample_configuration/IndicesGetAllSampleConfigurationRequest.ts +++ b/specification/indices/get_all_sample_configuration/IndicesGetAllSampleConfigurationRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get all sampling configurations. + * * Get the sampling configurations for all indices. * @rest_spec_name indices.get_all_sample_configuration * @availability stack visibility=feature_flag feature_flag=random_sampling since=9.3.0 stability=experimental diff --git a/specification/indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsRequest.ts b/specification/indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsRequest.ts index 9a665f491d..2963930215 100644 --- a/specification/indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsRequest.ts +++ b/specification/indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get data stream lifecycle stats. + * * Get statistics about the data streams that are managed by a data stream lifecycle. * @rest_spec_name indices.get_data_lifecycle_stats * @availability stack since=8.12.0 stability=stable diff --git a/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts b/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts index 6804fd0f7e..af4e8431b8 100644 --- a/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts +++ b/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Fields, Indices } from '@_types/common' /** * Get mapping definitions. + * * Retrieves mapping definitions for one or more fields. * For data streams, the API retrieves field mappings for the stream’s backing indices. * diff --git a/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts b/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts index 33f161bd58..dbdd05693f 100644 --- a/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts +++ b/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get index templates. + * * Get information about one or more index templates. * @rest_spec_name indices.get_index_template * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/get_mapping/IndicesGetMappingRequest.ts b/specification/indices/get_mapping/IndicesGetMappingRequest.ts index 51dbc7fb7e..18fb0c5e75 100644 --- a/specification/indices/get_mapping/IndicesGetMappingRequest.ts +++ b/specification/indices/get_mapping/IndicesGetMappingRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get mapping definitions. + * * For data streams, the API retrieves mappings for the stream’s backing indices. * @rest_spec_name indices.get_mapping * @availability stack stability=stable diff --git a/specification/indices/get_sample_configuration/IndicesGetSampleConfigurationRequest.ts b/specification/indices/get_sample_configuration/IndicesGetSampleConfigurationRequest.ts index aaceacebc7..e3a25207b8 100644 --- a/specification/indices/get_sample_configuration/IndicesGetSampleConfigurationRequest.ts +++ b/specification/indices/get_sample_configuration/IndicesGetSampleConfigurationRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get sampling configuration. + * * Get the sampling configuration for the specified index. * @rest_spec_name indices.get_sample_configuration * @availability stack visibility=feature_flag feature_flag=random_sampling since=9.3.0 stability=experimental diff --git a/specification/indices/get_settings/IndicesGetSettingsRequest.ts b/specification/indices/get_settings/IndicesGetSettingsRequest.ts index d5cdfbf1dd..ddf5ee713b 100644 --- a/specification/indices/get_settings/IndicesGetSettingsRequest.ts +++ b/specification/indices/get_settings/IndicesGetSettingsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get index settings. + * * Get setting information for one or more indices. * For data streams, it returns setting information for the stream's backing indices. * @rest_spec_name indices.get_settings diff --git a/specification/indices/get_template/IndicesGetTemplateRequest.ts b/specification/indices/get_template/IndicesGetTemplateRequest.ts index a9ba95bbb0..5dd5734a31 100644 --- a/specification/indices/get_template/IndicesGetTemplateRequest.ts +++ b/specification/indices/get_template/IndicesGetTemplateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get legacy index templates. + * * Get information about one or more index templates. * * IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. diff --git a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts index 2aecf81b32..97279688f1 100644 --- a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts +++ b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Convert an index alias to a data stream. + * * Converts an index alias to a data stream. * You must have a matching index template that is data stream enabled. * The alias must meet the following criteria: diff --git a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts index 245477fce6..3337265cb6 100644 --- a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts +++ b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts @@ -22,6 +22,7 @@ import { Action } from './types' /** * Update data streams. + * * Performs one or more data stream modification actions in a single atomic operation. * @rest_spec_name indices.modify_data_stream * @availability stack since=7.16.0 stability=stable diff --git a/specification/indices/open/IndicesOpenRequest.ts b/specification/indices/open/IndicesOpenRequest.ts index bb0ebc3be8..14aef859a7 100644 --- a/specification/indices/open/IndicesOpenRequest.ts +++ b/specification/indices/open/IndicesOpenRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Open a closed index. + * * For data streams, the API opens any closed backing indices. * * A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. diff --git a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts index 906d3510d7..c694ba0e28 100644 --- a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts +++ b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Promote a data stream. + * * Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. * * With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. diff --git a/specification/indices/put_alias/IndicesPutAliasRequest.ts b/specification/indices/put_alias/IndicesPutAliasRequest.ts index b45196c063..06aec5f5d0 100644 --- a/specification/indices/put_alias/IndicesPutAliasRequest.ts +++ b/specification/indices/put_alias/IndicesPutAliasRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * Create or update an alias. + * * Adds a data stream or index to an alias. * @rest_spec_name indices.put_alias * @availability stack stability=stable diff --git a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts index 32570f3ec2..56b652227d 100644 --- a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts +++ b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts @@ -24,6 +24,7 @@ import { DownsamplingRound } from '@indices/_types/DownsamplingRound' /** * Update data stream lifecycles. + * * Update the data stream lifecycle of the specified data streams. * @rest_spec_name indices.put_data_lifecycle * @availability stack since=8.11.0 stability=stable diff --git a/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts b/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts index 9bfd90f1e5..61bf39e4b6 100644 --- a/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts +++ b/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts @@ -24,6 +24,7 @@ import { DataStreamFailureStore } from '@indices/_types/DataStreamFailureStore' /** * Update data stream options. + * * Update the data stream options of the specified data streams. * @rest_spec_name indices.put_data_stream_options * @availability stack since=8.19.0 stability=stable diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts index d655526a64..dfe9e8f53c 100644 --- a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts +++ b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts @@ -36,6 +36,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Create or update an index template. + * * Index templates define settings, mappings, and aliases that can be applied automatically to new indices. * * Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. diff --git a/specification/indices/put_mapping/IndicesPutMappingRequest.ts b/specification/indices/put_mapping/IndicesPutMappingRequest.ts index bed2283bdc..69061bec0a 100644 --- a/specification/indices/put_mapping/IndicesPutMappingRequest.ts +++ b/specification/indices/put_mapping/IndicesPutMappingRequest.ts @@ -40,9 +40,10 @@ import { Dictionary, SingleKeyDictionary } from '@spec_utils/Dictionary' /** * Update field mappings. + * * Add new fields to an existing data stream or index. * You can use the update mapping API to: - + * * - Add a new field to an existing index * - Update mappings for multiple indices in a single request * - Add new properties to an object field diff --git a/specification/indices/put_sample_configuration/IndicesPutSampleConfigurationRequest.ts b/specification/indices/put_sample_configuration/IndicesPutSampleConfigurationRequest.ts index 6a612ba1cf..7f9f141ea1 100644 --- a/specification/indices/put_sample_configuration/IndicesPutSampleConfigurationRequest.ts +++ b/specification/indices/put_sample_configuration/IndicesPutSampleConfigurationRequest.ts @@ -25,6 +25,7 @@ import { Stringified } from '@spec_utils/Stringified' /** * Create or update sampling configuration. + * * Create or update the sampling configuration for the specified index. * @rest_spec_name indices.put_sample_configuration * @availability stack visibility=feature_flag feature_flag=random_sampling since=9.3.0 stability=experimental diff --git a/specification/indices/put_settings/IndicesPutSettingsRequest.ts b/specification/indices/put_settings/IndicesPutSettingsRequest.ts index 5e364246a6..1fc5a3e4f2 100644 --- a/specification/indices/put_settings/IndicesPutSettingsRequest.ts +++ b/specification/indices/put_settings/IndicesPutSettingsRequest.ts @@ -24,6 +24,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings' /** * Update index settings. + * * Changes dynamic index settings in real time. * For data streams, index setting changes are applied to all backing indices by default. * diff --git a/specification/indices/put_template/IndicesPutTemplateRequest.ts b/specification/indices/put_template/IndicesPutTemplateRequest.ts index a1c5507f67..b378c728e3 100644 --- a/specification/indices/put_template/IndicesPutTemplateRequest.ts +++ b/specification/indices/put_template/IndicesPutTemplateRequest.ts @@ -28,6 +28,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Create or update a legacy index template. + * * Index templates define settings, mappings, and aliases that can be applied automatically to new indices. * Elasticsearch applies templates to new indices based on an index pattern that matches the index name. * diff --git a/specification/indices/recovery/IndicesRecoveryRequest.ts b/specification/indices/recovery/IndicesRecoveryRequest.ts index 61153a3568..ae268fd3e5 100644 --- a/specification/indices/recovery/IndicesRecoveryRequest.ts +++ b/specification/indices/recovery/IndicesRecoveryRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Get index recovery information. + * * Get information about ongoing and completed shard recoveries for one or more indices. * For data streams, the API returns information for the stream's backing indices. * diff --git a/specification/indices/refresh/IndicesRefreshRequest.ts b/specification/indices/refresh/IndicesRefreshRequest.ts index 478a923fe0..3b04e97010 100644 --- a/specification/indices/refresh/IndicesRefreshRequest.ts +++ b/specification/indices/refresh/IndicesRefreshRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Refresh an index. + * * A refresh makes recent operations performed on one or more indices available for search. * For data streams, the API runs the refresh operation on the stream’s backing indices. * diff --git a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts index 5bab1b32f8..1575944e8c 100644 --- a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts +++ b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Reload search analyzers. + * * Reload an index's search analyzers and their resources. * For data streams, the API reloads search analyzers and resources for the stream's backing indices. * diff --git a/specification/indices/resolve_index/ResolveIndexRequest.ts b/specification/indices/resolve_index/ResolveIndexRequest.ts index 65bad15e33..3a128d0a8b 100644 --- a/specification/indices/resolve_index/ResolveIndexRequest.ts +++ b/specification/indices/resolve_index/ResolveIndexRequest.ts @@ -23,6 +23,7 @@ import { IndexMode } from '@indices/_types/DataStream' /** * Resolve indices. + * * Resolve the names and/or index patterns for indices, aliases, and data streams. * Multiple patterns and remote clusters are supported. * @rest_spec_name indices.resolve_index diff --git a/specification/indices/rollover/IndicesRolloverRequest.ts b/specification/indices/rollover/IndicesRolloverRequest.ts index 22a02afe76..02d345d6d1 100644 --- a/specification/indices/rollover/IndicesRolloverRequest.ts +++ b/specification/indices/rollover/IndicesRolloverRequest.ts @@ -28,6 +28,7 @@ import { RolloverConditions } from './types' /** * Roll over to a new index. + * * TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context. * * The rollover API creates a new index for a data stream or index alias. diff --git a/specification/indices/segments/IndicesSegmentsRequest.ts b/specification/indices/segments/IndicesSegmentsRequest.ts index a90e6b9d4a..9a4d3eacf5 100644 --- a/specification/indices/segments/IndicesSegmentsRequest.ts +++ b/specification/indices/segments/IndicesSegmentsRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Get index segments. + * * Get low-level information about the Lucene segments in index shards. * For data streams, the API returns information about the stream's backing indices. * @rest_spec_name indices.segments diff --git a/specification/indices/shard_stores/IndicesShardStoresRequest.ts b/specification/indices/shard_stores/IndicesShardStoresRequest.ts index f635a98157..dcda697990 100644 --- a/specification/indices/shard_stores/IndicesShardStoresRequest.ts +++ b/specification/indices/shard_stores/IndicesShardStoresRequest.ts @@ -23,6 +23,7 @@ import { ShardStoreStatus } from './types' /** * Get index shard stores. + * * Get store information about replica shards in one or more indices. * For data streams, the API retrieves store information for the stream's backing indices. * diff --git a/specification/indices/shrink/IndicesShrinkRequest.ts b/specification/indices/shrink/IndicesShrinkRequest.ts index 159e272c86..1209226eaf 100644 --- a/specification/indices/shrink/IndicesShrinkRequest.ts +++ b/specification/indices/shrink/IndicesShrinkRequest.ts @@ -26,6 +26,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Shrink an index. + * * Shrink an index into a new index with fewer primary shards. * * Before you can shrink an index: diff --git a/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts b/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts index 5b3e340276..f9b95367c4 100644 --- a/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts +++ b/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts @@ -24,6 +24,7 @@ import { IndexTemplate } from '@indices/_types/IndexTemplate' /** * Simulate an index. + * * Get the index configuration that would be applied to the specified index from an existing index template. * @rest_spec_name indices.simulate_index_template * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts index 93c1d9197e..33f83469a8 100644 --- a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts +++ b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts @@ -26,6 +26,7 @@ import { IndexTemplateMapping } from '@indices/put_index_template/IndicesPutInde /** * Simulate an index template. + * * Get the index configuration that would be applied by a particular index template. * @rest_spec_name indices.simulate_template * @availability stack stability=stable diff --git a/specification/indices/split/IndicesSplitRequest.ts b/specification/indices/split/IndicesSplitRequest.ts index 726d57a4e4..108b940be8 100644 --- a/specification/indices/split/IndicesSplitRequest.ts +++ b/specification/indices/split/IndicesSplitRequest.ts @@ -26,6 +26,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Split an index. + * * Split an index into a new index with more primary shards. * * Before you can split an index: * diff --git a/specification/indices/stats/IndicesStatsRequest.ts b/specification/indices/stats/IndicesStatsRequest.ts index a921bc59ad..73999d8098 100644 --- a/specification/indices/stats/IndicesStatsRequest.ts +++ b/specification/indices/stats/IndicesStatsRequest.ts @@ -28,6 +28,7 @@ import { /** * Get index statistics. + * * For data streams, the API retrieves statistics for the stream's backing indices. * * By default, the returned statistics are index-level with `primaries` and `total` aggregations. diff --git a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts index d0c6f0e1fa..e6b574b593 100644 --- a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts +++ b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts @@ -23,6 +23,7 @@ import { Action } from './types' /** * Create or update an alias. + * * Adds a data stream or index to an alias. * @rest_spec_name indices.update_aliases * @availability stack since=1.3.0 stability=stable diff --git a/specification/indices/validate_query/IndicesValidateQueryRequest.ts b/specification/indices/validate_query/IndicesValidateQueryRequest.ts index b9cbfbba8b..a36e04cac4 100644 --- a/specification/indices/validate_query/IndicesValidateQueryRequest.ts +++ b/specification/indices/validate_query/IndicesValidateQueryRequest.ts @@ -24,6 +24,7 @@ import { Operator } from '@_types/query_dsl/Operator' /** * Validate a query. + * * Validates a query without running it. * @rest_spec_name indices.validate_query * @availability stack since=1.3.0 stability=stable diff --git a/specification/inference/chat_completion_unified/UnifiedRequest.ts b/specification/inference/chat_completion_unified/UnifiedRequest.ts index 6c79b0a6a2..8cfa4edf7d 100644 --- a/specification/inference/chat_completion_unified/UnifiedRequest.ts +++ b/specification/inference/chat_completion_unified/UnifiedRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' import { RequestChatCompletion } from '@inference/_types/CommonTypes' /** - * Perform chat completion inference on the service + * Perform chat completion inference on the service. * * The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. * It only works with the `chat_completion` task type for `openai` and `elastic` inference services. diff --git a/specification/inference/completion/CompletionRequest.ts b/specification/inference/completion/CompletionRequest.ts index d255ec3015..8b77e8d26b 100644 --- a/specification/inference/completion/CompletionRequest.ts +++ b/specification/inference/completion/CompletionRequest.ts @@ -23,7 +23,8 @@ import { Duration } from '@_types/Time' import { TaskSettings } from '@inference/_types/Services' /** - * Perform completion inference on the service + * Perform completion inference on the service. + * * Get responses for completion tasks. * This API works only with the completion task type. * diff --git a/specification/inference/delete/DeleteRequest.ts b/specification/inference/delete/DeleteRequest.ts index 7f155db264..c0eae5130e 100644 --- a/specification/inference/delete/DeleteRequest.ts +++ b/specification/inference/delete/DeleteRequest.ts @@ -22,7 +22,8 @@ import { Id } from '@_types/common' import { TaskType } from '@inference/_types/TaskType' /** - * Delete an inference endpoint + * Delete an inference endpoint. + * * This API requires the manage_inference cluster privilege (the built-in `inference_admin` role grants this privilege). * @rest_spec_name inference.delete * @availability stack since=8.11.0 stability=stable visibility=public diff --git a/specification/inference/get/GetRequest.ts b/specification/inference/get/GetRequest.ts index ac6356e9eb..67275da914 100644 --- a/specification/inference/get/GetRequest.ts +++ b/specification/inference/get/GetRequest.ts @@ -22,7 +22,8 @@ import { Id } from '@_types/common' import { TaskType } from '@inference/_types/TaskType' /** - * Get an inference endpoint + * Get an inference endpoint. + * * This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). * @rest_spec_name inference.get * @availability stack since=8.11.0 stability=stable visibility=public diff --git a/specification/inference/rerank/RerankRequest.ts b/specification/inference/rerank/RerankRequest.ts index 53ac180bad..8cb6b5f8f5 100644 --- a/specification/inference/rerank/RerankRequest.ts +++ b/specification/inference/rerank/RerankRequest.ts @@ -24,7 +24,8 @@ import { Duration } from '@_types/Time' import { TaskSettings } from '@inference/_types/Services' /** - * Perform reranking inference on the service + * Perform reranking inference on the service. + * * @rest_spec_name inference.rerank * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public diff --git a/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts b/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts index 0775c718ff..460ae70028 100644 --- a/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts +++ b/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts @@ -23,7 +23,8 @@ import { Duration } from '@_types/Time' import { TaskSettings } from '@inference/_types/Services' /** - * Perform sparse embedding inference on the service + * Perform sparse embedding inference on the service. + * * @rest_spec_name inference.sparse_embedding * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public diff --git a/specification/inference/stream_completion/StreamInferenceRequest.ts b/specification/inference/stream_completion/StreamInferenceRequest.ts index 5543f21338..604bc9d99c 100644 --- a/specification/inference/stream_completion/StreamInferenceRequest.ts +++ b/specification/inference/stream_completion/StreamInferenceRequest.ts @@ -23,7 +23,8 @@ import { Duration } from '@_types/Time' import { TaskSettings } from '@inference/_types/Services' /** - * Perform streaming completion inference on the service + * Perform streaming completion inference on the service. + * * Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. * This API works only with the completion task type. * diff --git a/specification/inference/text_embedding/TextEmbeddingRequest.ts b/specification/inference/text_embedding/TextEmbeddingRequest.ts index dacda5e23d..d925870a93 100644 --- a/specification/inference/text_embedding/TextEmbeddingRequest.ts +++ b/specification/inference/text_embedding/TextEmbeddingRequest.ts @@ -23,7 +23,8 @@ import { Duration } from '@_types/Time' import { TaskSettings } from '@inference/_types/Services' /** - * Perform text embedding inference on the service + * Perform text embedding inference on the service. + * * @rest_spec_name inference.text_embedding * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public diff --git a/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts b/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts index 83381e0163..b309c0e44a 100644 --- a/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts +++ b/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete IP geolocation database configurations. + * * @rest_spec_name ingest.delete_ip_location_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private diff --git a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts index d6e7478218..971216f65e 100644 --- a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts +++ b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete pipelines. + * * Delete one or more ingest pipelines. * @rest_spec_name ingest.delete_pipeline * @availability stack since=5.0.0 stability=stable diff --git a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts index 2923eb6cb4..fd78525d9c 100644 --- a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts +++ b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get GeoIP statistics. + * * Get download statistics for GeoIP2 databases that are used with the GeoIP processor. * @doc_id geoip-processor * @rest_spec_name ingest.geo_ip_stats diff --git a/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts b/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts index b38a64f029..02165193fa 100644 --- a/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts +++ b/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts @@ -22,6 +22,7 @@ import { Ids } from '@_types/common' /** * Get IP geolocation database configurations. + * * @rest_spec_name ingest.get_ip_location_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private diff --git a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts index 1fac5be4ec..42eb53d875 100644 --- a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts +++ b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Run a grok processor. + * * Extract structured fields out of a single text field within a document. * You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. * A grok pattern is like a regular expression that supports aliased expressions that can be reused. diff --git a/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts b/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts index 0ebc199297..eccefcaee5 100644 --- a/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts +++ b/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts @@ -24,6 +24,7 @@ import { DatabaseConfiguration } from '@ingest/_types/Database' /** * Create or update an IP geolocation database configuration. + * * @rest_spec_name ingest.put_ip_location_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private diff --git a/specification/ingest/put_pipeline/PutPipelineRequest.ts b/specification/ingest/put_pipeline/PutPipelineRequest.ts index 193730df45..00ab5ef1e0 100644 --- a/specification/ingest/put_pipeline/PutPipelineRequest.ts +++ b/specification/ingest/put_pipeline/PutPipelineRequest.ts @@ -25,6 +25,7 @@ import { ProcessorContainer } from '@ingest/_types/Processors' /** * Create or update a pipeline. + * * Changes made using this API take effect immediately. * @doc_id ingest * @rest_spec_name ingest.put_pipeline diff --git a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts index 7287abce0c..515a4a3007 100644 --- a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts +++ b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get the basic license status. + * * @rest_spec_name license.get_basic_status * @availability stack since=6.3.0 stability=stable * @cluster_privileges monitor diff --git a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts index a9f0d6b8d9..e7c7bff946 100644 --- a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts +++ b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get the trial status. + * * @rest_spec_name license.get_trial_status * @availability stack since=6.1.0 stability=stable * @cluster_privileges monitor diff --git a/specification/license/post_start_trial/StartTrialLicenseRequest.ts b/specification/license/post_start_trial/StartTrialLicenseRequest.ts index ad33b3072a..9ff4b5eb18 100644 --- a/specification/license/post_start_trial/StartTrialLicenseRequest.ts +++ b/specification/license/post_start_trial/StartTrialLicenseRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Start a trial. + * * Start a 30-day trial, which gives access to all subscription features. * * NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. diff --git a/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts index 53a43cb6b9..4b760e3632 100644 --- a/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts +++ b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete a Logstash pipeline. + * * Delete a pipeline that is used for Logstash Central Management. * If the request succeeds, you receive an empty response with an appropriate status code. * @rest_spec_name logstash.delete_pipeline diff --git a/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts index 61025edada..fd9d885685 100644 --- a/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts +++ b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts @@ -22,6 +22,7 @@ import { Ids } from '@_types/common' /** * Get Logstash pipelines. + * * Get pipelines that are used for Logstash Central Management. * @rest_spec_name logstash.get_pipeline * @availability stack since=7.12.0 stability=stable diff --git a/specification/migration/deprecations/DeprecationInfoRequest.ts b/specification/migration/deprecations/DeprecationInfoRequest.ts index 6c8e83efa6..563a442c75 100644 --- a/specification/migration/deprecations/DeprecationInfoRequest.ts +++ b/specification/migration/deprecations/DeprecationInfoRequest.ts @@ -22,6 +22,7 @@ import { IndexName } from '@_types/common' /** * Get deprecation information. + * * Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. * * TIP: This APIs is designed for indirect use by the Upgrade Assistant. diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts index 7544b39cdf..abc2b77c10 100644 --- a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts +++ b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get feature migration information. + * * Version upgrades sometimes require changes to how features store configuration information and data in system indices. * Check which features need to be migrated and the status of any migrations that are in progress. * diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts index ad3e9530bb..0cb17952ea 100644 --- a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts +++ b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Start the feature migration. + * * Version upgrades sometimes require changes to how features store configuration information and data in system indices. * This API starts the automatic migration process. * diff --git a/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts b/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts index 0355641189..758028f2f4 100644 --- a/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts +++ b/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete events from a calendar. + * * @rest_spec_name ml.delete_calendar_event * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts b/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts index c2909aa3ac..044508d4e9 100644 --- a/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts +++ b/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts @@ -22,6 +22,7 @@ import { Id, Ids } from '@_types/common' /** * Delete anomaly jobs from a calendar. + * * @rest_spec_name ml.delete_calendar_job * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts index 7b15ca57de..0042ef7ea1 100644 --- a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts +++ b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete a data frame analytics job. + * * @rest_spec_name ml.delete_data_frame_analytics * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts b/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts index 2f35026c4c..af5d5e8969 100644 --- a/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts +++ b/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete a datafeed. + * * @rest_spec_name ml.delete_datafeed * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/flush_job/MlFlushJobRequest.ts b/specification/ml/flush_job/MlFlushJobRequest.ts index ac558c5867..c222b26200 100644 --- a/specification/ml/flush_job/MlFlushJobRequest.ts +++ b/specification/ml/flush_job/MlFlushJobRequest.ts @@ -23,6 +23,7 @@ import { DateTime } from '@_types/Time' /** * Force buffered data to be processed. + * * The flush jobs API is only applicable when sending data for analysis using * the post data API. Depending on the content of the buffer, then it might * additionally calculate new results. Both flush and close operations are diff --git a/specification/ml/get_buckets/MlGetBucketsRequest.ts b/specification/ml/get_buckets/MlGetBucketsRequest.ts index 9f0168958a..d748ef9df8 100644 --- a/specification/ml/get_buckets/MlGetBucketsRequest.ts +++ b/specification/ml/get_buckets/MlGetBucketsRequest.ts @@ -25,6 +25,7 @@ import { Page } from '@ml/_types/Page' /** * Get anomaly detection job results for buckets. + * * The API presents a chronological view of the records, grouped by bucket. * @rest_spec_name ml.get_buckets * @availability stack since=5.4.0 stability=stable diff --git a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts index ec0071c32f..06b6762bf8 100644 --- a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts +++ b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts @@ -24,6 +24,7 @@ import { DateTime } from '@_types/Time' /** * Get info about events in calendars. + * * @rest_spec_name ml.get_calendar_events * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_calendars/MlGetCalendarsRequest.ts b/specification/ml/get_calendars/MlGetCalendarsRequest.ts index 2dd33a526d..1ac5239d4f 100644 --- a/specification/ml/get_calendars/MlGetCalendarsRequest.ts +++ b/specification/ml/get_calendars/MlGetCalendarsRequest.ts @@ -24,6 +24,7 @@ import { Page } from '@ml/_types/Page' /** * Get calendar configuration info. + * * @rest_spec_name ml.get_calendars * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_categories/MlGetCategoriesRequest.ts b/specification/ml/get_categories/MlGetCategoriesRequest.ts index a558d95927..33775b7e0d 100644 --- a/specification/ml/get_categories/MlGetCategoriesRequest.ts +++ b/specification/ml/get_categories/MlGetCategoriesRequest.ts @@ -24,6 +24,7 @@ import { Page } from '@ml/_types/Page' /** * Get anomaly detection job results for categories. + * * @rest_spec_name ml.get_categories * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts index ad7abdc1c7..d08f8901b9 100644 --- a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts +++ b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts @@ -23,6 +23,7 @@ import { integer } from '@_types/Numeric' /** * Get data frame analytics job configuration info. + * * You can get information for multiple data frame analytics jobs in a single * API request by using a comma-separated list of data frame analytics jobs or a * wildcard expression. diff --git a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts index 0389c50eaa..f5dacfb80f 100644 --- a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts +++ b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts @@ -23,6 +23,7 @@ import { integer } from '@_types/Numeric' /** * Get data frame analytics job stats. + * * @rest_spec_name ml.get_data_frame_analytics_stats * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts index b2235aea0f..82a7fd891d 100644 --- a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts +++ b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts @@ -22,6 +22,7 @@ import { Ids } from '@_types/common' /** * Get datafeed stats. + * * You can get statistics for multiple datafeeds in a single API request by * using a comma-separated list of datafeeds or a wildcard expression. You can * get statistics for all datafeeds by using `_all`, by specifying `*` as the diff --git a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts index 73fa0b7f3a..80697ab977 100644 --- a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts +++ b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts @@ -22,6 +22,7 @@ import { Ids } from '@_types/common' /** * Get datafeeds configuration info. + * * You can get information for multiple datafeeds in a single API request by * using a comma-separated list of datafeeds or a wildcard expression. You can * get information for all datafeeds by using `_all`, by specifying `*` as the diff --git a/specification/ml/get_filters/MlGetFiltersRequest.ts b/specification/ml/get_filters/MlGetFiltersRequest.ts index 35f8fcdd41..38b0d4f0c0 100644 --- a/specification/ml/get_filters/MlGetFiltersRequest.ts +++ b/specification/ml/get_filters/MlGetFiltersRequest.ts @@ -23,6 +23,7 @@ import { integer } from '@_types/Numeric' /** * Get filters. + * * You can get a single filter or all filters. * @rest_spec_name ml.get_filters * @availability stack since=5.5.0 stability=stable diff --git a/specification/ml/get_influencers/MlGetInfluencersRequest.ts b/specification/ml/get_influencers/MlGetInfluencersRequest.ts index 43c0476c82..e0d79fdc8a 100644 --- a/specification/ml/get_influencers/MlGetInfluencersRequest.ts +++ b/specification/ml/get_influencers/MlGetInfluencersRequest.ts @@ -25,6 +25,7 @@ import { Page } from '@ml/_types/Page' /** * Get anomaly detection job results for influencers. + * * Influencers are the entities that have contributed to, or are to blame for, * the anomalies. Influencer results are available only if an * `influencer_field_name` is specified in the job configuration. diff --git a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts index 712c52fbc7..3cf8bb1dc9 100644 --- a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts +++ b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Get anomaly detection job stats. + * * @rest_spec_name ml.get_job_stats * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_jobs/MlGetJobsRequest.ts b/specification/ml/get_jobs/MlGetJobsRequest.ts index b9903ea9ab..36928d7eab 100644 --- a/specification/ml/get_jobs/MlGetJobsRequest.ts +++ b/specification/ml/get_jobs/MlGetJobsRequest.ts @@ -22,6 +22,7 @@ import { Ids } from '@_types/common' /** * Get anomaly detection jobs configuration info. + * * You can get information for multiple anomaly detection jobs in a single API * request by using a group name, a comma-separated list of jobs, or a wildcard * expression. You can get information for all anomaly detection jobs by using diff --git a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts index 070b821be5..08afd10949 100644 --- a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts +++ b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get machine learning memory usage info. + * * Get information about how machine learning jobs and trained models are using memory, * on each node, both within the JVM heap, and natively, outside of the JVM. * @rest_spec_name ml.get_memory_stats diff --git a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts index b77dfeb678..e66a059181 100644 --- a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts +++ b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Get anomaly detection job model snapshot upgrade usage info. + * * @rest_spec_name ml.get_model_snapshot_upgrade_stats * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts index b7e028c000..8343629001 100644 --- a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts +++ b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts @@ -25,6 +25,7 @@ import { Page } from '@ml/_types/Page' /** * Get model snapshots info. + * * @rest_spec_name ml.get_model_snapshots * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts index dea86932d0..87bc44aaa3 100644 --- a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts +++ b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts @@ -25,6 +25,7 @@ import { Page } from '@ml/_types/Page' /** * Get anomaly records for an anomaly detection job. + * * Records contain the detailed analytical results. They describe the anomalous * activity that has been identified in the input data based on the detector * configuration. diff --git a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts index 49ab03a737..50bb0d7eda 100644 --- a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts +++ b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts @@ -24,6 +24,7 @@ import { Include } from '@ml/_types/Include' /** * Get trained model configuration info. + * * @rest_spec_name ml.get_trained_models * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts index cb69027d12..f12cfe4a58 100644 --- a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts +++ b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts @@ -23,6 +23,7 @@ import { integer } from '@_types/Numeric' /** * Get trained models usage info. + * * You can get usage information for multiple trained * models in a single API request by using a comma-separated list of model IDs or a wildcard expression. * @rest_spec_name ml.get_trained_models_stats diff --git a/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts b/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts index d3dc96d86b..93ab9923d9 100644 --- a/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts +++ b/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts @@ -26,6 +26,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Evaluate a trained model. + * * @rest_spec_name ml.infer_trained_model * @availability stack since=8.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/info/MlInfoRequest.ts b/specification/ml/info/MlInfoRequest.ts index 4b50f9e469..d19e99646d 100644 --- a/specification/ml/info/MlInfoRequest.ts +++ b/specification/ml/info/MlInfoRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get machine learning information. + * * Get defaults and limits used by machine learning. * This endpoint is designed to be used by a user interface that needs to fully * understand machine learning configurations where some options are not diff --git a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts index f8eea3311e..d3a6d4d8f1 100644 --- a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts +++ b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts @@ -23,6 +23,7 @@ import { CalendarEvent } from '../_types/CalendarEvent' /** * Add scheduled events to the calendar. + * * @rest_spec_name ml.post_calendar_events * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts index bc1c0a2ea2..7dc1e6d294 100644 --- a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts +++ b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts @@ -23,6 +23,7 @@ import { DataframePreviewConfig } from './types' /** * Preview features used by data frame analytics. + * * Preview the extracted features used by a data frame analytics config. * @rest_spec_name ml.preview_data_frame_analytics * @availability stack since=7.13.0 stability=stable diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts index 8112cf536c..434dc52c9f 100644 --- a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts +++ b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts @@ -25,6 +25,7 @@ import { JobConfig } from '@ml/_types/Job' /** * Preview a datafeed. + * * This API returns the first "page" of search results from a datafeed. * You can preview an existing datafeed or provide configuration details for a datafeed * and anomaly detection job in the API. The preview shows the structure of the data diff --git a/specification/ml/put_calendar/MlPutCalendarRequest.ts b/specification/ml/put_calendar/MlPutCalendarRequest.ts index 4c01210a91..fd3780bb85 100644 --- a/specification/ml/put_calendar/MlPutCalendarRequest.ts +++ b/specification/ml/put_calendar/MlPutCalendarRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Create a calendar. + * * @rest_spec_name ml.put_calendar * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts index ca9a1acc9b..a49e89f265 100644 --- a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts +++ b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts @@ -22,6 +22,7 @@ import { Id, Ids } from '@_types/common' /** * Add anomaly detection job to calendar. + * * @rest_spec_name ml.put_calendar_job * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts index c2dca85ebc..058869c8f8 100644 --- a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts +++ b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts @@ -29,6 +29,7 @@ import { /** * Create a data frame analytics job. + * * This API creates a data frame analytics job that performs an analysis on the * source indices and stores the outcome in a destination index. * By default, the query used in the source configuration is `{"match_all": {}}`. diff --git a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts index a0b646db70..e0df3bc5c9 100644 --- a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts +++ b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts @@ -36,6 +36,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Create a datafeed. + * * Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. * You can associate only one datafeed with each anomaly detection job. * The datafeed contains a query that runs at a defined interval (`frequency`). diff --git a/specification/ml/put_filter/MlPutFilterRequest.ts b/specification/ml/put_filter/MlPutFilterRequest.ts index eeb3ae8b30..65b404573e 100644 --- a/specification/ml/put_filter/MlPutFilterRequest.ts +++ b/specification/ml/put_filter/MlPutFilterRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Create a filter. + * * A filter contains a list of strings. It can be used by one or more anomaly detection jobs. * Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. * @rest_spec_name ml.put_filter diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 7d9ce13d0c..6bfbaa8df5 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -30,6 +30,7 @@ import { Definition, Input } from './types' /** * Create a trained model. + * * Enable you to supply a trained model that is not created by data frame analytics. * @rest_spec_name ml.put_trained_model * @availability stack since=7.10.0 stability=stable diff --git a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts index 26529dcc44..ce66e70a3e 100644 --- a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts +++ b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts @@ -22,6 +22,7 @@ import { Id, Name } from '@_types/common' /** * Create or update a trained model alias. + * * A trained model alias is a logical name used to reference a single trained * model. * You can use aliases instead of trained model identifiers to make it easier to diff --git a/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts b/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts index d3c3709912..5b87206a0f 100644 --- a/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts +++ b/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts @@ -23,6 +23,7 @@ import { integer, long } from '@_types/Numeric' /** * Create part of a trained model definition. + * * @rest_spec_name ml.put_trained_model_definition_part * @availability stack since=8.0.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts b/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts index 82d0f705b2..69de8c1779 100644 --- a/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts +++ b/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts @@ -23,6 +23,7 @@ import { double } from '@_types/Numeric' /** * Create a trained model vocabulary. + * * This API is supported only for natural language processing (NLP) models. * The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. * @rest_spec_name ml.put_trained_model_vocabulary diff --git a/specification/ml/reset_job/MlResetJobRequest.ts b/specification/ml/reset_job/MlResetJobRequest.ts index 8d557e57ae..f30f4eb52d 100644 --- a/specification/ml/reset_job/MlResetJobRequest.ts +++ b/specification/ml/reset_job/MlResetJobRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Reset an anomaly detection job. + * * All model state and results are deleted. The job is ready to start over as if * it had just been created. * It is not currently possible to reset multiple jobs using wildcards or a diff --git a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts index 2402d673a2..7b91fae5da 100644 --- a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts +++ b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Revert to a snapshot. + * * The machine learning features react quickly to anomalous input, learning new * behaviors in data. Highly anomalous input increases the variance in the * models whilst the system learns whether this is a new step-change in behavior diff --git a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts index 3911d13932..a2d5c75060 100644 --- a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts +++ b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Set upgrade_mode for ML indices. + * * Sets a cluster wide upgrade_mode setting that prepares machine learning * indices for an upgrade. * When upgrading your cluster, in some circumstances you must restart your diff --git a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts index 3a6eade3cd..17f4a901a0 100644 --- a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts +++ b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Start a data frame analytics job. + * * A data frame analytics job can be started and stopped multiple times * throughout its lifecycle. * If the destination index does not exist, it is created automatically the diff --git a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts index c592b880eb..33008ff949 100644 --- a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts +++ b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts @@ -29,6 +29,7 @@ import { /** * Start a trained model deployment. + * * It allocates the model to every machine learning node. * @rest_spec_name ml.start_trained_model_deployment * @availability stack since=8.0.0 stability=stable diff --git a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts index 69da7b97d3..8155c2ae88 100644 --- a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts +++ b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Stop data frame analytics jobs. + * * A data frame analytics job can be started and stopped multiple times * throughout its lifecycle. * @rest_spec_name ml.stop_data_frame_analytics diff --git a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts index e474f3bd94..3da646d13c 100644 --- a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts +++ b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Stop datafeeds. + * * A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped * multiple times throughout its lifecycle. * @rest_spec_name ml.stop_datafeed diff --git a/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts index 6cf4488e80..7eaf0b5785 100644 --- a/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts +++ b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Stop a trained model deployment. + * * @rest_spec_name ml.stop_trained_model_deployment * @availability stack since=8.0.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts index e17e37c44b..2ab5ed4e5e 100644 --- a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts +++ b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts @@ -23,6 +23,7 @@ import { integer } from '@_types/Numeric' /** * Update a data frame analytics job. + * * @rest_spec_name ml.update_data_frame_analytics * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts index 1c711475a6..f89e40bbf4 100644 --- a/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts +++ b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts @@ -30,6 +30,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Update a datafeed. + * * You must stop and start the datafeed for the changes to be applied. * When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at * the time of the update and runs the query using those same roles. If you provide secondary authorization headers, diff --git a/specification/ml/update_filter/MlUpdateFilterRequest.ts b/specification/ml/update_filter/MlUpdateFilterRequest.ts index 3fdbece406..48d493a86a 100644 --- a/specification/ml/update_filter/MlUpdateFilterRequest.ts +++ b/specification/ml/update_filter/MlUpdateFilterRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Update a filter. + * * Updates the description of a filter, adds items, or removes items from the list. * @rest_spec_name ml.update_filter * @availability stack since=6.4.0 stability=stable diff --git a/specification/ml/update_job/MlUpdateJobRequest.ts b/specification/ml/update_job/MlUpdateJobRequest.ts index 9405479234..5ff310a307 100644 --- a/specification/ml/update_job/MlUpdateJobRequest.ts +++ b/specification/ml/update_job/MlUpdateJobRequest.ts @@ -32,6 +32,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Update an anomaly detection job. + * * Updates certain properties of an anomaly detection job. * @rest_spec_name ml.update_job * @availability stack since=5.5.0 stability=stable diff --git a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts index 77cc691324..f76b62f03b 100644 --- a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts +++ b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Update a snapshot. + * * Updates certain properties of a snapshot. * @rest_spec_name ml.update_model_snapshot * @availability stack since=5.4.0 stability=stable diff --git a/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts b/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts index f6d4291811..17ef18c743 100644 --- a/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts +++ b/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts @@ -24,6 +24,7 @@ import { AdaptiveAllocationsSettings } from '@ml/_types/TrainedModel' /** * Update a trained model deployment. + * * @rest_spec_name ml.update_trained_model_deployment * @availability stack since=8.6.0 stability=stable * @availability serverless stability=beta visibility=public diff --git a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts index 2729224c8f..8cc5a01879 100644 --- a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts +++ b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Upgrade a snapshot. + * * Upgrade an anomaly detection model snapshot to the latest major version. * Over time, older snapshot formats are deprecated and removed. Anomaly * detection jobs support only snapshots that are from the current or previous diff --git a/specification/ml/validate/MlValidateJobRequest.ts b/specification/ml/validate/MlValidateJobRequest.ts index baabc67f60..3a5d0bf38a 100644 --- a/specification/ml/validate/MlValidateJobRequest.ts +++ b/specification/ml/validate/MlValidateJobRequest.ts @@ -26,6 +26,7 @@ import { ModelPlotConfig } from '@ml/_types/ModelPlot' /** * Validate an anomaly detection job. + * * @rest_spec_name ml.validate * @availability stack since=6.3.0 stability=stable visibility=private * @availability serverless stability=stable visibility=private diff --git a/specification/ml/validate_detector/MlValidateDetectorRequest.ts b/specification/ml/validate_detector/MlValidateDetectorRequest.ts index 6a674d1232..d792a68521 100644 --- a/specification/ml/validate_detector/MlValidateDetectorRequest.ts +++ b/specification/ml/validate_detector/MlValidateDetectorRequest.ts @@ -22,6 +22,7 @@ import { Detector } from '@ml/_types/Detector' /** * Validate an anomaly detection job. + * * @rest_spec_name ml.validate_detector * @availability stack since=5.4.0 stability=stable visibility=private * @availability serverless stability=stable visibility=private diff --git a/specification/monitoring/bulk/BulkMonitoringRequest.ts b/specification/monitoring/bulk/BulkMonitoringRequest.ts index 7df75e0f99..86c8b12802 100644 --- a/specification/monitoring/bulk/BulkMonitoringRequest.ts +++ b/specification/monitoring/bulk/BulkMonitoringRequest.ts @@ -23,6 +23,7 @@ import { OperationContainer, UpdateAction } from '@global/bulk/types' /** * Send monitoring data. + * * This API is used by the monitoring features to send monitoring data. * @rest_spec_name monitoring.bulk * @availability stack since=6.3.0 stability=stable visibility=private diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts index df50881678..47cf1d7597 100644 --- a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts +++ b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts @@ -23,6 +23,7 @@ import { long } from '@_types/Numeric' /** * Clear the archived repositories metering. + * * Clear the archived repositories metering information in the cluster. * @rest_spec_name nodes.clear_repositories_metering_archive * @availability stack since=7.16.0 stability=experimental diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts index 3b867ed28d..3a3357ca73 100644 --- a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts @@ -22,6 +22,7 @@ import { NodeIds } from '@_types/common' /** * Get cluster repositories metering. + * * Get repositories metering information for a cluster. * This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. * Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. diff --git a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts index d1622fd633..eac346a324 100644 --- a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts +++ b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * Get the hot threads for nodes. + * * Get a breakdown of the hot threads on each selected node in the cluster. * The output is plain text with a breakdown of the top hot threads for each node. * @rest_spec_name nodes.hot_threads diff --git a/specification/nodes/stats/NodesStatsRequest.ts b/specification/nodes/stats/NodesStatsRequest.ts index 152399cad6..518e747a3e 100644 --- a/specification/nodes/stats/NodesStatsRequest.ts +++ b/specification/nodes/stats/NodesStatsRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' /** * Get node statistics. + * * Get statistics for nodes in a cluster. * By default, all stats are returned. You can limit the returned information by using metrics. * @rest_spec_name nodes.stats diff --git a/specification/nodes/usage/NodesUsageRequest.ts b/specification/nodes/usage/NodesUsageRequest.ts index 37e7b31b71..b10839afb1 100644 --- a/specification/nodes/usage/NodesUsageRequest.ts +++ b/specification/nodes/usage/NodesUsageRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get feature usage information. + * * @rest_spec_name nodes.usage * @availability stack since=6.0.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/project/tags/TagsRequest.ts b/specification/project/tags/TagsRequest.ts index f74d3c0c99..25f3b57778 100644 --- a/specification/project/tags/TagsRequest.ts +++ b/specification/project/tags/TagsRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get tags. + * * Get the tags that are defined for the project. * @doc_id project-tags * @rest_spec_name project.tags diff --git a/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts b/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts index 54aa6805a7..04474c7b8e 100644 --- a/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts +++ b/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Delete a query rule. + * * Delete a query rule within a query ruleset. * This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. * @rest_spec_name query_rules.delete_rule diff --git a/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts b/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts index 79ca7d7b2c..2e0b18b5d9 100644 --- a/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts +++ b/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Delete a query ruleset. + * * Remove a query ruleset and its associated data. * This is a destructive action that is not recoverable. * @rest_spec_name query_rules.delete_ruleset diff --git a/specification/query_rules/get_rule/QueryRuleGetRequest.ts b/specification/query_rules/get_rule/QueryRuleGetRequest.ts index b4fc43268a..b100b5eacf 100644 --- a/specification/query_rules/get_rule/QueryRuleGetRequest.ts +++ b/specification/query_rules/get_rule/QueryRuleGetRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Get a query rule. + * * Get details about a query rule within a query ruleset. * @rest_spec_name query_rules.get_rule * @availability stack since=8.15.0 stability=stable diff --git a/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts b/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts index dc567ce945..24bc68c594 100644 --- a/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts +++ b/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Get a query ruleset. + * * Get details about a query ruleset. * @rest_spec_name query_rules.get_ruleset * @availability stack since=8.10.0 stability=stable diff --git a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts index cc7f3c2521..70441e6b3b 100644 --- a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts +++ b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts @@ -21,6 +21,7 @@ import { integer } from '@_types/Numeric' /** * Get all query rulesets. + * * Get summarized information about the query rulesets. * @rest_spec_name query_rules.list_rulesets * @availability stack since=8.10.0 stability=stable diff --git a/specification/query_rules/put_rule/QueryRulePutRequest.ts b/specification/query_rules/put_rule/QueryRulePutRequest.ts index b705b3e2a5..173cea95a7 100644 --- a/specification/query_rules/put_rule/QueryRulePutRequest.ts +++ b/specification/query_rules/put_rule/QueryRulePutRequest.ts @@ -27,6 +27,7 @@ import { /** * Create or update a query rule. + * * Create or update a query rule within a query ruleset. * * IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. diff --git a/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts b/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts index ed0d208b3d..3ace2ef6be 100644 --- a/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts +++ b/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts @@ -22,6 +22,7 @@ import { QueryRule } from '../_types/QueryRuleset' /** * Create or update a query ruleset. + * * There is a limit of 100 rules per ruleset. * This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting. * diff --git a/specification/query_rules/test/QueryRulesetTestRequest.ts b/specification/query_rules/test/QueryRulesetTestRequest.ts index eca0c862e1..6548948c0c 100644 --- a/specification/query_rules/test/QueryRulesetTestRequest.ts +++ b/specification/query_rules/test/QueryRulesetTestRequest.ts @@ -23,6 +23,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Test a query ruleset. + * * Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. * @rest_spec_name query_rules.test * @availability stack since=8.10.0 stability=stable diff --git a/specification/rollup/get_jobs/GetRollupJobRequest.ts b/specification/rollup/get_jobs/GetRollupJobRequest.ts index 04efd8ebf4..b954d6ef27 100644 --- a/specification/rollup/get_jobs/GetRollupJobRequest.ts +++ b/specification/rollup/get_jobs/GetRollupJobRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Get rollup job information. + * * Get the configuration, stats, and status of rollup jobs. * * NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. diff --git a/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts index d8a78ef658..33643fdd45 100644 --- a/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts +++ b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Get the rollup job capabilities. + * * Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. * * This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. diff --git a/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts index 6eb1acfbca..c2e86eece9 100644 --- a/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts +++ b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts @@ -22,6 +22,7 @@ import { Ids } from '@_types/common' /** * Get the rollup index capabilities. + * * Get the rollup capabilities of all jobs inside of a rollup index. * A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: * diff --git a/specification/rollup/rollup_search/RollupSearchRequest.ts b/specification/rollup/rollup_search/RollupSearchRequest.ts index 760a336a46..65983912a9 100644 --- a/specification/rollup/rollup_search/RollupSearchRequest.ts +++ b/specification/rollup/rollup_search/RollupSearchRequest.ts @@ -26,6 +26,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Search rolled-up data. + * * The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. * It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. * diff --git a/specification/rollup/start_job/StartRollupJobRequest.ts b/specification/rollup/start_job/StartRollupJobRequest.ts index e11a1e6513..d9f1966a67 100644 --- a/specification/rollup/start_job/StartRollupJobRequest.ts +++ b/specification/rollup/start_job/StartRollupJobRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Start rollup jobs. + * * If you try to start a job that does not exist, an exception occurs. * If you try to start a job that is already started, nothing happens. * @rest_spec_name rollup.start_job diff --git a/specification/rollup/stop_job/StopRollupJobRequest.ts b/specification/rollup/stop_job/StopRollupJobRequest.ts index b2874514af..755e14fc5e 100644 --- a/specification/rollup/stop_job/StopRollupJobRequest.ts +++ b/specification/rollup/stop_job/StopRollupJobRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Stop rollup jobs. + * * If you try to stop a job that does not exist, an exception occurs. * If you try to stop a job that is already stopped, nothing happens. * @@ -39,7 +40,6 @@ import { Duration } from '@_types/Time' * @cluster_privileges manage_rollup * @deprecated 8.11.0 * @doc_id rollup-stop-job - * */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts b/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts index b3985d4c6f..5bb0b73c28 100644 --- a/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts +++ b/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts @@ -21,6 +21,7 @@ import { Name } from '@_types/common' /** * Delete a behavioral analytics collection. + * * The associated data stream is also deleted. * @rest_spec_name search_application.delete_behavioral_analytics * @availability stack since=8.8.0 stability=experimental diff --git a/specification/search_application/get/SearchApplicationsGetRequest.ts b/specification/search_application/get/SearchApplicationsGetRequest.ts index d321d38675..e62bbbf8e9 100644 --- a/specification/search_application/get/SearchApplicationsGetRequest.ts +++ b/specification/search_application/get/SearchApplicationsGetRequest.ts @@ -21,6 +21,7 @@ import { Name } from '@_types/common' /** * Get search application details. + * * @rest_spec_name search_application.get * @availability stack since=8.8.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts index 0dbbfade07..b1c6665794 100644 --- a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts +++ b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts @@ -21,6 +21,7 @@ import { Name } from '@_types/common' /** * Get behavioral analytics collections. + * * @rest_spec_name search_application.get_behavioral_analytics * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public diff --git a/specification/search_application/list/SearchApplicationsListRequest.ts b/specification/search_application/list/SearchApplicationsListRequest.ts index 5297ffbf3e..be9c022d86 100644 --- a/specification/search_application/list/SearchApplicationsListRequest.ts +++ b/specification/search_application/list/SearchApplicationsListRequest.ts @@ -21,6 +21,7 @@ import { integer } from '@_types/Numeric' /** * Get search applications. + * * Get information about search applications. * @rest_spec_name search_application.list * @availability stack since=8.8.0 stability=beta diff --git a/specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequest.ts b/specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequest.ts index 4fb502e591..3cdbb8f7b6 100644 --- a/specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequest.ts +++ b/specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequest.ts @@ -23,6 +23,7 @@ import { EventType } from '../_types/AnalyticsEvent' /** * Create a behavioral analytics collection event. + * * @rest_spec_name search_application.post_behavioral_analytics_event * @availability stack stability=experimental visibility=public * @doc_tag analytics diff --git a/specification/search_application/put/SearchApplicationsPutRequest.ts b/specification/search_application/put/SearchApplicationsPutRequest.ts index f681970c34..6666192157 100644 --- a/specification/search_application/put/SearchApplicationsPutRequest.ts +++ b/specification/search_application/put/SearchApplicationsPutRequest.ts @@ -22,6 +22,7 @@ import { SearchApplicationParameters } from '../_types/SearchApplicationParamete /** * Create or update a search application. + * * @rest_spec_name search_application.put * @availability stack since=8.8.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts index 24b5313ac3..b0dc92b5e7 100644 --- a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts +++ b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts @@ -21,6 +21,7 @@ import { Name } from '@_types/common' /** * Create a behavioral analytics collection. + * * @rest_spec_name search_application.put_behavioral_analytics * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public diff --git a/specification/search_application/render_query/SearchApplicationsRenderQueryRequest.ts b/specification/search_application/render_query/SearchApplicationsRenderQueryRequest.ts index 764ed292c0..ead408d831 100644 --- a/specification/search_application/render_query/SearchApplicationsRenderQueryRequest.ts +++ b/specification/search_application/render_query/SearchApplicationsRenderQueryRequest.ts @@ -23,6 +23,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Render a search application query. + * * Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. * If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. * The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. diff --git a/specification/search_application/search/SearchApplicationsSearchRequest.ts b/specification/search_application/search/SearchApplicationsSearchRequest.ts index 55e8d0e21c..c472a5a940 100644 --- a/specification/search_application/search/SearchApplicationsSearchRequest.ts +++ b/specification/search_application/search/SearchApplicationsSearchRequest.ts @@ -23,6 +23,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Run a search application search. + * * Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. * Unspecified template parameters are assigned their default values if applicable. * @rest_spec_name search_application.search diff --git a/specification/searchable_snapshots/cache_stats/Request.ts b/specification/searchable_snapshots/cache_stats/Request.ts index 7d392e36ef..8b8f91c036 100644 --- a/specification/searchable_snapshots/cache_stats/Request.ts +++ b/specification/searchable_snapshots/cache_stats/Request.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get cache statistics. + * * Get statistics about the shared cache for partially mounted indices. * @rest_spec_name searchable_snapshots.cache_stats * @availability stack since=7.13.0 stability=experimental diff --git a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts index 975650e1bd..6fa43ab6ab 100644 --- a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts +++ b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * Clear the cache. + * * Clear indices and data streams from the shared cache for partially mounted indices. * @rest_spec_name searchable_snapshots.clear_cache * @availability stack since=7.10.0 stability=experimental diff --git a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts index 97ee5c0318..97d285a77f 100644 --- a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts +++ b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts @@ -25,6 +25,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Mount a snapshot. + * * Mount a snapshot as a searchable snapshot index. * Do not use this API for snapshots managed by index lifecycle management (ILM). * Manually mounting ILM-managed snapshots can interfere with ILM processes. diff --git a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts index e376952582..76fb3761fc 100644 --- a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts +++ b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts @@ -23,6 +23,7 @@ import { StatsLevel } from '../_types/stats' /** * Get searchable snapshot statistics. + * * @rest_spec_name searchable_snapshots.stats * @availability stack since=7.10.0 stability=stable * @cluster_privileges manage diff --git a/specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequest.ts b/specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequest.ts index 56247e2ec0..cd9fe8656e 100644 --- a/specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequest.ts +++ b/specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequest.ts @@ -25,6 +25,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Bulk update API keys. + * * Update the attributes for multiple API keys. * * IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required. diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index 6828edce69..6b211b4d2b 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Cancel node shutdown preparations. + * * Remove a node from the shutdown list so it can resume normal operations. * You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. * Shutdown requests are never removed automatically by Elasticsearch. diff --git a/specification/simulate/ingest/SimulateIngestRequest.ts b/specification/simulate/ingest/SimulateIngestRequest.ts index 5369d92bec..59c8f428b1 100644 --- a/specification/simulate/ingest/SimulateIngestRequest.ts +++ b/specification/simulate/ingest/SimulateIngestRequest.ts @@ -28,6 +28,7 @@ import { Dictionary } from '@spec_utils/Dictionary' /** * Simulate data ingestion. + * * Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. * * This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. diff --git a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts index 931f152090..452bc50be5 100644 --- a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts +++ b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete a policy. + * * Delete a snapshot lifecycle policy definition. * This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. * @rest_spec_name slm.delete_lifecycle diff --git a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts index f9310b5f74..2285c0db98 100644 --- a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts +++ b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Run a policy. + * * Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. * The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. * @rest_spec_name slm.execute_lifecycle diff --git a/specification/slm/execute_retention/ExecuteRetentionRequest.ts b/specification/slm/execute_retention/ExecuteRetentionRequest.ts index cf11e7e1b6..223053f515 100644 --- a/specification/slm/execute_retention/ExecuteRetentionRequest.ts +++ b/specification/slm/execute_retention/ExecuteRetentionRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Run a retention policy. + * * Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. * The retention policy is normally applied according to its schedule. * @rest_spec_name slm.execute_retention diff --git a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts index 288d038222..1ab5a2e87c 100644 --- a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts +++ b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get policy information. + * * Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. * @rest_spec_name slm.get_lifecycle * @availability stack since=7.4.0 stability=stable diff --git a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts index 0fb38d11f0..c893875b9c 100644 --- a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts +++ b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get snapshot lifecycle management statistics. + * * Get global and policy-level statistics about actions taken by snapshot lifecycle management. * @rest_spec_name slm.get_stats * @availability stack since=7.5.0 stability=stable diff --git a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts index caed92f439..a767e33d25 100644 --- a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts +++ b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get the snapshot lifecycle management status. + * * @rest_spec_name slm.get_status * @availability stack since=7.6.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts index c107360fa2..dec4f0ffb9 100644 --- a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts +++ b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts @@ -25,6 +25,7 @@ import { CronExpression } from '@watcher/_types/Schedule' /** * Create or update a policy. + * * Create or update a snapshot lifecycle policy. * If the policy already exists, this request increments the policy version. * Only the latest version of a policy is stored. diff --git a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts index 87ac896a65..8fa68d3545 100644 --- a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Start snapshot lifecycle management. + * * Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. * Manually starting SLM is necessary only if it has been stopped using the stop SLM API. * @rest_spec_name slm.start diff --git a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts index 39c26941d9..54d112795a 100644 --- a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Stop snapshot lifecycle management. + * * Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. * This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. * Stopping SLM does not stop any snapshots that are in progress. diff --git a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts index 3288d28883..32c61495e6 100644 --- a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts +++ b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Clean up the snapshot repository. + * * Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. * @rest_spec_name snapshot.cleanup_repository * @availability stack since=7.4.0 stability=stable diff --git a/specification/snapshot/clone/SnapshotCloneRequest.ts b/specification/snapshot/clone/SnapshotCloneRequest.ts index c39473aec1..425bfb9e72 100644 --- a/specification/snapshot/clone/SnapshotCloneRequest.ts +++ b/specification/snapshot/clone/SnapshotCloneRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Clone a snapshot. + * * Clone part of all of a snapshot into another snapshot in the same repository. * @rest_spec_name snapshot.clone * @availability stack since=7.10.0 stability=stable diff --git a/specification/snapshot/create/SnapshotCreateRequest.ts b/specification/snapshot/create/SnapshotCreateRequest.ts index 89716422c0..dea4efb177 100644 --- a/specification/snapshot/create/SnapshotCreateRequest.ts +++ b/specification/snapshot/create/SnapshotCreateRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Create a snapshot. + * * Take a snapshot of a cluster or of data streams and indices. * @rest_spec_name snapshot.create * @availability stack stability=stable diff --git a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts index 427cbf73a8..2e57938d9a 100644 --- a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts +++ b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts @@ -24,6 +24,7 @@ import { Repository } from '@snapshot/_types/SnapshotRepository' /** * Create or update a snapshot repository. + * * IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. * To register a snapshot repository, the cluster's global metadata must be writeable. * Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access. diff --git a/specification/snapshot/delete/SnapshotDeleteRequest.ts b/specification/snapshot/delete/SnapshotDeleteRequest.ts index eae6112d9a..c54ca11cb3 100644 --- a/specification/snapshot/delete/SnapshotDeleteRequest.ts +++ b/specification/snapshot/delete/SnapshotDeleteRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete snapshots. + * * @rest_spec_name snapshot.delete * @availability stack stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts index 19ee50fc3d..eb2e70ab89 100644 --- a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts +++ b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete snapshot repositories. + * * When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. * The snapshots themselves are left untouched and in place. * @rest_spec_name snapshot.delete_repository diff --git a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts index 0ab0bc6b22..90b2b7173a 100644 --- a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts +++ b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get snapshot repository information. + * * @rest_spec_name snapshot.get_repository * @availability stack stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts b/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts index 5e3eef9233..4cb195e3f3 100644 --- a/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts +++ b/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts @@ -23,6 +23,7 @@ import { integer } from '@_types/Numeric' /** * Verify the repository integrity. + * * Verify the integrity of the contents of a snapshot repository. * * This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. diff --git a/specification/snapshot/restore/SnapshotRestoreRequest.ts b/specification/snapshot/restore/SnapshotRestoreRequest.ts index 1fd52c82ed..0e011988f9 100644 --- a/specification/snapshot/restore/SnapshotRestoreRequest.ts +++ b/specification/snapshot/restore/SnapshotRestoreRequest.ts @@ -24,6 +24,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings' /** * Restore a snapshot. + * * Restore a snapshot of a cluster or data streams and indices. * * You can restore a snapshot only to a running cluster with an elected master node. diff --git a/specification/snapshot/status/SnapshotStatusRequest.ts b/specification/snapshot/status/SnapshotStatusRequest.ts index 1b17752bda..2791b69352 100644 --- a/specification/snapshot/status/SnapshotStatusRequest.ts +++ b/specification/snapshot/status/SnapshotStatusRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get the snapshot status. + * * Get a detailed description of the current state for each shard participating in the snapshot. * * Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. diff --git a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts index b3ac543a90..ed8547fd71 100644 --- a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts +++ b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Verify a snapshot repository. + * * Check for common misconfigurations in a snapshot repository. * @rest_spec_name snapshot.verify_repository * @availability stack stability=stable diff --git a/specification/sql/clear_cursor/ClearSqlCursorRequest.ts b/specification/sql/clear_cursor/ClearSqlCursorRequest.ts index cf5bbf08ee..6bbb7ca293 100644 --- a/specification/sql/clear_cursor/ClearSqlCursorRequest.ts +++ b/specification/sql/clear_cursor/ClearSqlCursorRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Clear an SQL search cursor. + * * @rest_spec_name sql.clear_cursor * @availability stack since=6.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/sql/delete_async/SqlDeleteAsyncRequest.ts b/specification/sql/delete_async/SqlDeleteAsyncRequest.ts index d51efd6149..024a721d4d 100644 --- a/specification/sql/delete_async/SqlDeleteAsyncRequest.ts +++ b/specification/sql/delete_async/SqlDeleteAsyncRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete an async SQL search. + * * Delete an async SQL search or a stored synchronous SQL search. * If the search is still running, the API cancels it. * diff --git a/specification/sql/get_async/SqlGetAsyncRequest.ts b/specification/sql/get_async/SqlGetAsyncRequest.ts index 3d51d11263..3e9249f69a 100644 --- a/specification/sql/get_async/SqlGetAsyncRequest.ts +++ b/specification/sql/get_async/SqlGetAsyncRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get async SQL search results. + * * Get the current status and available results for an async SQL search or stored synchronous SQL search. * * If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API. diff --git a/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts b/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts index b9349c880e..6bafce1ca6 100644 --- a/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts +++ b/specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Get the async SQL search status. + * * Get the current status of an async SQL search or a stored synchronous SQL search. * @rest_spec_name sql.get_async_status * @availability stack since=7.15.0 stability=stable diff --git a/specification/sql/query/QuerySqlRequest.ts b/specification/sql/query/QuerySqlRequest.ts index f0f631cd1a..33580becde 100644 --- a/specification/sql/query/QuerySqlRequest.ts +++ b/specification/sql/query/QuerySqlRequest.ts @@ -27,6 +27,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * Get SQL search results. + * * Run an SQL request. * @rest_spec_name sql.query * @availability stack since=6.3.0 stability=stable diff --git a/specification/sql/translate/TranslateSqlRequest.ts b/specification/sql/translate/TranslateSqlRequest.ts index ed821ff017..94fb2679ed 100644 --- a/specification/sql/translate/TranslateSqlRequest.ts +++ b/specification/sql/translate/TranslateSqlRequest.ts @@ -24,6 +24,7 @@ import { TimeZone } from '@_types/Time' /** * Translate SQL into Elasticsearch queries. + * * Translate an SQL search into a search API request containing Query DSL. * It accepts the same request body parameters as the SQL search API, excluding `cursor`. * @rest_spec_name sql.translate diff --git a/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts b/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts index 6ae296a578..c739de92e8 100644 --- a/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts +++ b/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Delete a synonym rule. + * * Delete a synonym rule from a synonym set. * @rest_spec_name synonyms.delete_synonym_rule * @availability stack since=8.10.0 stability=stable diff --git a/specification/synonyms/get_synonym/SynonymsGetRequest.ts b/specification/synonyms/get_synonym/SynonymsGetRequest.ts index 336ffc8ec0..a10b64a6e5 100644 --- a/specification/synonyms/get_synonym/SynonymsGetRequest.ts +++ b/specification/synonyms/get_synonym/SynonymsGetRequest.ts @@ -22,6 +22,7 @@ import { integer } from '@_types/Numeric' /** * Get a synonym set. + * * @rest_spec_name synonyms.get_synonym * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts b/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts index a2ea13c5a0..a93f51f64d 100644 --- a/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts +++ b/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' /** * Get a synonym rule. + * * Get a synonym rule from a synonym set. * @rest_spec_name synonyms.get_synonym_rule * @availability stack since=8.10.0 stability=stable diff --git a/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts b/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts index d9387522ad..482717b04f 100644 --- a/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts +++ b/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts @@ -21,6 +21,7 @@ import { integer } from '@_types/Numeric' /** * Get all synonym sets. + * * Get a summary of all defined synonym sets. * @rest_spec_name synonyms.get_synonyms_sets * @availability stack since=8.10.0 stability=stable diff --git a/specification/synonyms/put_synonym/SynonymsPutRequest.ts b/specification/synonyms/put_synonym/SynonymsPutRequest.ts index 5408b22e6b..3e3704343e 100644 --- a/specification/synonyms/put_synonym/SynonymsPutRequest.ts +++ b/specification/synonyms/put_synonym/SynonymsPutRequest.ts @@ -22,6 +22,7 @@ import { SynonymRule } from '../_types/SynonymRule' /** * Create or update a synonym set. + * * Synonyms sets are limited to a maximum of 10,000 synonym rules per set. * If you need to manage more synonym rules, you can create multiple synonym sets. * diff --git a/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts b/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts index 83e187d00d..ff2b1e0776 100644 --- a/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts +++ b/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts @@ -22,6 +22,7 @@ import { SynonymString } from '../_types/SynonymRule' /** * Create or update a synonym rule. + * * Create or update a synonym rule in a synonym set. * * If any of the synonym rules included is invalid, the API returns an error. diff --git a/specification/tasks/get/GetTaskRequest.ts b/specification/tasks/get/GetTaskRequest.ts index 9f626071ad..3a78fa2728 100644 --- a/specification/tasks/get/GetTaskRequest.ts +++ b/specification/tasks/get/GetTaskRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get task information. + * * Get information about a task currently running in the cluster. * * WARNING: The task management API is new and should still be considered a beta feature. diff --git a/specification/tasks/list/ListTasksRequest.ts b/specification/tasks/list/ListTasksRequest.ts index 1e29df5594..e4406bbab2 100644 --- a/specification/tasks/list/ListTasksRequest.ts +++ b/specification/tasks/list/ListTasksRequest.ts @@ -24,6 +24,7 @@ import { GroupBy } from '@tasks/_types/GroupBy' /** * Get all tasks. + * * Get information about the tasks currently running on one or more nodes in the cluster. * * WARNING: The task management API is new and should still be considered a beta feature. diff --git a/specification/text_structure/find_field_structure/FindFieldStructureRequest.ts b/specification/text_structure/find_field_structure/FindFieldStructureRequest.ts index 9d72a59c09..11c7c920e7 100644 --- a/specification/text_structure/find_field_structure/FindFieldStructureRequest.ts +++ b/specification/text_structure/find_field_structure/FindFieldStructureRequest.ts @@ -25,6 +25,7 @@ import { EcsCompatibilityType, FormatType } from '../_types/Structure' /** * Find the structure of a text field. + * * Find the structure of a text field in an Elasticsearch index. * * This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. diff --git a/specification/text_structure/find_message_structure/FindMessageStructureRequest.ts b/specification/text_structure/find_message_structure/FindMessageStructureRequest.ts index ecb109ccf4..58b0a5c8f4 100644 --- a/specification/text_structure/find_message_structure/FindMessageStructureRequest.ts +++ b/specification/text_structure/find_message_structure/FindMessageStructureRequest.ts @@ -24,6 +24,7 @@ import { EcsCompatibilityType, FormatType } from '../_types/Structure' /** * Find the structure of text messages. + * * Find the structure of a list of text messages. * The messages must contain data that is suitable to be ingested into Elasticsearch. * diff --git a/specification/text_structure/find_structure/FindStructureRequest.ts b/specification/text_structure/find_structure/FindStructureRequest.ts index 7a2a442ee7..8bdaeb0580 100644 --- a/specification/text_structure/find_structure/FindStructureRequest.ts +++ b/specification/text_structure/find_structure/FindStructureRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Find the structure of a text file. + * * The text file must contain data that is suitable to be ingested into Elasticsearch. * * This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. diff --git a/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts b/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts index 1fd6062aba..4ea23738a7 100644 --- a/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts +++ b/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts @@ -22,6 +22,7 @@ import { GrokPattern } from '@_types/common' /** * Test a Grok pattern. + * * Test a Grok pattern on one or more lines of text. * The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. * @rest_spec_name text_structure.test_grok_pattern diff --git a/specification/transform/delete_transform/DeleteTransformRequest.ts b/specification/transform/delete_transform/DeleteTransformRequest.ts index e509f22b94..8d94847884 100644 --- a/specification/transform/delete_transform/DeleteTransformRequest.ts +++ b/specification/transform/delete_transform/DeleteTransformRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete a transform. + * * @rest_spec_name transform.delete_transform * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/transform/get_transform/GetTransformRequest.ts b/specification/transform/get_transform/GetTransformRequest.ts index 1b33f6bb4c..b4cd626517 100644 --- a/specification/transform/get_transform/GetTransformRequest.ts +++ b/specification/transform/get_transform/GetTransformRequest.ts @@ -23,6 +23,7 @@ import { integer } from '@_types/Numeric' /** * Get transforms. + * * Get configuration information for transforms. * @rest_spec_name transform.get_transform * @availability stack since=7.5.0 stability=stable diff --git a/specification/transform/preview_transform/PreviewTransformRequest.ts b/specification/transform/preview_transform/PreviewTransformRequest.ts index 0de93ec7f8..9ccbf3d820 100644 --- a/specification/transform/preview_transform/PreviewTransformRequest.ts +++ b/specification/transform/preview_transform/PreviewTransformRequest.ts @@ -32,6 +32,7 @@ import { /** * Preview a transform. + * * Generates a preview of the results that you will get when you create a transform with the same configuration. * * It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also diff --git a/specification/transform/put_transform/PutTransformRequest.ts b/specification/transform/put_transform/PutTransformRequest.ts index 2387f13e75..0c8ef045a8 100644 --- a/specification/transform/put_transform/PutTransformRequest.ts +++ b/specification/transform/put_transform/PutTransformRequest.ts @@ -32,6 +32,7 @@ import { /** * Create a transform. + * * Creates a transform. * * A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as diff --git a/specification/transform/set_upgrade_mode/TransformSetUpgradeModeRequest.ts b/specification/transform/set_upgrade_mode/TransformSetUpgradeModeRequest.ts index a6918ca012..d9d4569baa 100644 --- a/specification/transform/set_upgrade_mode/TransformSetUpgradeModeRequest.ts +++ b/specification/transform/set_upgrade_mode/TransformSetUpgradeModeRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Set upgrade_mode for transform indices. + * * Sets a cluster wide upgrade_mode setting that prepares transform * indices for an upgrade. * When upgrading your cluster, in some circumstances you must restart your diff --git a/specification/transform/stop_transform/StopTransformRequest.ts b/specification/transform/stop_transform/StopTransformRequest.ts index d9af7b62b4..b71c2589a0 100644 --- a/specification/transform/stop_transform/StopTransformRequest.ts +++ b/specification/transform/stop_transform/StopTransformRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Stop transforms. + * * Stops one or more transforms. * @rest_spec_name transform.stop_transform * @availability stack since=7.5.0 stability=stable diff --git a/specification/transform/update_transform/UpdateTransformRequest.ts b/specification/transform/update_transform/UpdateTransformRequest.ts index f47640ce36..3e237cdb7e 100644 --- a/specification/transform/update_transform/UpdateTransformRequest.ts +++ b/specification/transform/update_transform/UpdateTransformRequest.ts @@ -30,6 +30,7 @@ import { /** * Update a transform. + * * Updates certain properties of a transform. * * All updated properties except `description` do not take effect until after the transform starts the next checkpoint, diff --git a/specification/watcher/ack_watch/WatcherAckWatchRequest.ts b/specification/watcher/ack_watch/WatcherAckWatchRequest.ts index 6e62a343cc..edaf6bd216 100644 --- a/specification/watcher/ack_watch/WatcherAckWatchRequest.ts +++ b/specification/watcher/ack_watch/WatcherAckWatchRequest.ts @@ -22,6 +22,7 @@ import { Name, Names } from '@_types/common' /** * Acknowledge a watch. + * * Acknowledging a watch enables you to manually throttle the execution of the watch's actions. * * The acknowledgement state of an action is stored in the `status.actions..ack.state` structure. diff --git a/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts b/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts index f657949ebc..c42527a36c 100644 --- a/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts +++ b/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' /** * Activate a watch. + * * A watch can be either active or inactive. * @rest_spec_name watcher.activate_watch * @availability stack stability=stable diff --git a/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts b/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts index 52b7e7bb35..418940a05d 100644 --- a/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts +++ b/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' /** * Deactivate a watch. + * * A watch can be either active or inactive. * @rest_spec_name watcher.deactivate_watch * @availability stack stability=stable diff --git a/specification/watcher/delete_watch/DeleteWatchRequest.ts b/specification/watcher/delete_watch/DeleteWatchRequest.ts index 560a4dd8e8..f0f10b90b6 100644 --- a/specification/watcher/delete_watch/DeleteWatchRequest.ts +++ b/specification/watcher/delete_watch/DeleteWatchRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' /** * Delete a watch. + * * When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again. * * Deleting a watch does not delete any watch execution records related to this watch from the watch history. diff --git a/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts b/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts index 3aa46a54d7..926a09d9ec 100644 --- a/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts +++ b/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts @@ -27,6 +27,7 @@ import { Watch } from '@watcher/_types/Watch' /** * Run a watch. + * * This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes. * * For testing and debugging purposes, you also have fine-grained control on how the watch runs. diff --git a/specification/watcher/get_settings/WatcherGetSettingsRequest.ts b/specification/watcher/get_settings/WatcherGetSettingsRequest.ts index 16dfcc0719..a99686ef3f 100644 --- a/specification/watcher/get_settings/WatcherGetSettingsRequest.ts +++ b/specification/watcher/get_settings/WatcherGetSettingsRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get Watcher index settings. + * * Get settings for the Watcher internal index (`.watches`). * Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`. * @rest_spec_name watcher.get_settings diff --git a/specification/watcher/get_watch/GetWatchRequest.ts b/specification/watcher/get_watch/GetWatchRequest.ts index 0294a97127..206e1229d5 100644 --- a/specification/watcher/get_watch/GetWatchRequest.ts +++ b/specification/watcher/get_watch/GetWatchRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' /** * Get a watch. + * * @rest_spec_name watcher.get_watch * @availability stack since=5.6.0 stability=stable * @cluster_privileges monitor_watcher diff --git a/specification/watcher/put_watch/WatcherPutWatchRequest.ts b/specification/watcher/put_watch/WatcherPutWatchRequest.ts index 672c086067..9106fee23c 100644 --- a/specification/watcher/put_watch/WatcherPutWatchRequest.ts +++ b/specification/watcher/put_watch/WatcherPutWatchRequest.ts @@ -30,6 +30,7 @@ import { TriggerContainer } from '@watcher/_types/Trigger' /** * Create or update a watch. + * * When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. * Typically for the `schedule` trigger, the scheduler is the trigger engine. * diff --git a/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts b/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts index 473a78a26c..2a2d8079d4 100644 --- a/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts +++ b/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts @@ -24,6 +24,7 @@ import { Sort, SortResults } from '@_types/sort' /** * Query watches. + * * Get all registered watches in a paginated manner and optionally filter watches by a query. * * Note that only the `_id` and `metadata.*` fields are queryable or sortable. diff --git a/specification/watcher/start/WatcherStartRequest.ts b/specification/watcher/start/WatcherStartRequest.ts index 4c7726a82a..a6833f1b7a 100644 --- a/specification/watcher/start/WatcherStartRequest.ts +++ b/specification/watcher/start/WatcherStartRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Start the watch service. + * * Start the Watcher service if it is not already running. * @rest_spec_name watcher.start * @availability stack stability=stable diff --git a/specification/watcher/stats/WatcherStatsRequest.ts b/specification/watcher/stats/WatcherStatsRequest.ts index fb508b6dac..9798f08d14 100644 --- a/specification/watcher/stats/WatcherStatsRequest.ts +++ b/specification/watcher/stats/WatcherStatsRequest.ts @@ -22,6 +22,7 @@ import { WatcherMetric } from './types' /** * Get Watcher statistics. + * * This API always returns basic metrics. * You retrieve more metrics by using the metric parameter. * @rest_spec_name watcher.stats diff --git a/specification/watcher/stop/WatcherStopRequest.ts b/specification/watcher/stop/WatcherStopRequest.ts index 806d8c3586..16e4476180 100644 --- a/specification/watcher/stop/WatcherStopRequest.ts +++ b/specification/watcher/stop/WatcherStopRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Stop the watch service. + * * Stop the Watcher service if it is running. * @rest_spec_name watcher.stop * @availability stack stability=stable diff --git a/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts b/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts index b46f3780e1..1bb754ca8c 100644 --- a/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts +++ b/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Update Watcher index settings. + * * Update settings for the Watcher internal index (`.watches`). * Only a subset of settings can be modified. * This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, diff --git a/specification/xpack/info/XPackInfoRequest.ts b/specification/xpack/info/XPackInfoRequest.ts index 7b193c9196..275e91afd3 100644 --- a/specification/xpack/info/XPackInfoRequest.ts +++ b/specification/xpack/info/XPackInfoRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get information. + * * The information provided by the API includes: * * * Build information including the build number and timestamp. diff --git a/specification/xpack/usage/XPackUsageRequest.ts b/specification/xpack/usage/XPackUsageRequest.ts index 700b5df1fe..76459e5cfa 100644 --- a/specification/xpack/usage/XPackUsageRequest.ts +++ b/specification/xpack/usage/XPackUsageRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Get usage information. + * * Get information about the features that are currently enabled and available under the current license. * The API also provides some usage statistics. * @rest_spec_name xpack.usage diff --git a/validator/README.md b/validator/README.md index db473da611..c378497d9c 100644 --- a/validator/README.md +++ b/validator/README.md @@ -17,7 +17,8 @@ It is configured [in the specification directory](../specification/eslint.config | `no-inline-unions` | Inline union types (e.g., `field: A \| B`) are not allowed in properties/fields. Define a named type alias instead to improve code generation for statically-typed languages. | | `prefer-tagged-variants` | Union of class types should use tagged variants (`@variants internal` or `@variants container`) instead of inline unions for better deserialization support in statically-typed languages. | | `no-duplicate-type-names` | All types must be unique across class and enum definitions. | -| `no-all-string-literal-unions | Unions consisting entirely of string literals (e.g., `"green" \| "yellow" \| "red"`) are not allowed, use enums instead. | | +| `no-all-string-literal-unions` | Unions consisting entirely of string literals (e.g., `"green" \| "yellow" \| "red"`) are not allowed, use enums instead. | | +| `jsdoc-endpoint-check` | Validates JSDoc on endpoints in the specification. Ensuring consistent formatting. Some errors can be fixed with `--fix`. | ## Usage diff --git a/validator/eslint-plugin-es-spec.js b/validator/eslint-plugin-es-spec.js index 15028e809d..e1a768051e 100644 --- a/validator/eslint-plugin-es-spec.js +++ b/validator/eslint-plugin-es-spec.js @@ -27,6 +27,7 @@ import noInlineUnions from './rules/no-inline-unions.js' import preferTaggedVariants from './rules/prefer-tagged-variants.js' import noDuplicateTypeNames from './rules/no-duplicate-type-names.js' import noAllStringLiteralUnions from './rules/no-all-string-literal-unions.js' +import jsdocEndpointCheck from './rules/jsdoc-endpoint-check.js' export default { rules: { @@ -40,6 +41,7 @@ export default { 'no-inline-unions': noInlineUnions, 'prefer-tagged-variants': preferTaggedVariants, 'no-duplicate-type-names': noDuplicateTypeNames, - 'no-all-string-literal-unions': noAllStringLiteralUnions + 'no-all-string-literal-unions': noAllStringLiteralUnions, + 'jsdoc-endpoint-check': jsdocEndpointCheck } } diff --git a/validator/package.json b/validator/package.json index 573c85077c..661998f1cf 100644 --- a/validator/package.json +++ b/validator/package.json @@ -14,6 +14,7 @@ "license": "Apache-2.0", "dependencies": { "@typescript-eslint/utils": "^8.32.1", + "markdownlint": "^0.39.0", "typescript": "^5.8.3" }, "devDependencies": { diff --git a/validator/rules/jsdoc-endpoint-check.js b/validator/rules/jsdoc-endpoint-check.js new file mode 100644 index 0000000000..d5142b93e7 --- /dev/null +++ b/validator/rules/jsdoc-endpoint-check.js @@ -0,0 +1,269 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { ESLintUtils } from '@typescript-eslint/utils' +import { lint as markdownlintSync } from 'markdownlint/sync' + +const isLineEmpty = line => !line || line.trim() === '' + +const parseJSDoc = (jsdoc) => { + const lines = jsdoc.value + .split('\n') + .map(line => line.trim().replace(/^\*\s?/, '')) + + return { + lines, + summaryIndex: lines.findIndex(line => !isLineEmpty(line)), + lastNonEmptyIndex: lines.findLastIndex(line => !isLineEmpty(line)) + } +} + +const reconstructJSDoc = (lines) => { + let trimmedLines = [...lines] + + while (trimmedLines.length > 0 && isLineEmpty(trimmedLines[trimmedLines.length - 1])) { + trimmedLines.pop() + } + + if (trimmedLines.length > 0 && isLineEmpty(trimmedLines[0])) { + trimmedLines = trimmedLines.slice(1) + } + + const lineContent = trimmedLines.map(line => line ? ` * ${line}` : ' *').join('\n') + return `/**\n${lineContent}\n */` +} + +const fixers = { + firstLineShouldBeEmpty: (lines) => { + if (!isLineEmpty(lines[0])) { + return ['', lines[0], ...lines.slice(1)] + } + return lines + }, + + summaryMissingPeriod: (lines, { summaryIndex }) => { + if (summaryIndex !== -1) { + const fixed = [...lines] + fixed[summaryIndex] = lines[summaryIndex].trimEnd() + '.' + return fixed + } + return lines + }, + + lineAfterSummaryShouldBeEmpty: (lines, { summaryIndex }) => { + if (summaryIndex !== -1) { + const fixed = [...lines] + fixed.splice(summaryIndex + 1, 0, '') + return fixed + } + return lines + } +} + +const createJSDocFixer = (jsdoc, messageId) => { + const parsed = parseJSDoc(jsdoc) + const fixer = fixers[messageId] + + if (!fixer) return null + + const fixedLines = fixer(parsed.lines, parsed) + return (fix) => fix.replaceTextRange([jsdoc.range[0], jsdoc.range[1]], reconstructJSDoc(fixedLines)) +} + +const validateMarkdown = (lines, summaryIndex, startLine, column, markdownlintConfig) => { + const errors = [] + + // Extract description content + const descriptionStartIndex = summaryIndex + 2 + if (descriptionStartIndex >= lines.length) { + return errors + } + + const descriptionLines = lines.slice(descriptionStartIndex) + const description = descriptionLines.join('\n').trim() + + if (!description) { + return errors + } + + const result = markdownlintSync({ + strings: { + 'description': description + }, + config: markdownlintConfig + }) + + // Convert markdownlint errors to ESLint errors + const markdownErrors = result.description || [] + markdownErrors.forEach(error => { + const lineOffset = descriptionStartIndex + error.lineNumber - 1 + errors.push({ + messageId: 'markdownLintError', + line: startLine + lineOffset, + column, + canFix: false, + data: { + rule: error.ruleNames.join('/'), + detail: error.ruleDescription + (error.errorDetail ? `: ${error.errorDetail}` : '') + } + }) + }) + + return errors +} + +const validateJSDoc = (jsdoc, markdownlintConfig) => { + const { lines, summaryIndex, lastNonEmptyIndex } = parseJSDoc(jsdoc) + const { line: startLine, column } = jsdoc.loc.start + + const createError = (messageId, lineOffset, data, canFix = false) => ({ + messageId, + line: startLine + lineOffset, + column, + canFix, + ...(data && { data }) + }) + + const errors = [] + + if (!isLineEmpty(lines[0])) { + errors.push(createError('firstLineShouldBeEmpty', 0, null, true)) + } + + if (summaryIndex === -1 || (isLineEmpty(lines[0]) && summaryIndex !== 1)) { + errors.push(createError('missingSummary', 1)) + return errors + } + + const summary = lines[summaryIndex] + + if (/[*`\[\]#]/.test(summary)) { + errors.push(createError('summaryHasMarkup', summaryIndex)) + } + + if (!summary.trim().endsWith('.')) { + errors.push(createError('summaryMissingPeriod', summaryIndex, null, true)) + } + + const lineAfterSummary = summaryIndex + 1 + if (lineAfterSummary < lines.length && !isLineEmpty(lines[lineAfterSummary])) { + errors.push(createError('lineAfterSummaryShouldBeEmpty', lineAfterSummary, null, true)) + } + + // Validate markdown in description + errors.push(...validateMarkdown(lines, summaryIndex, startLine, column, markdownlintConfig)) + + return errors +} + +export const jsdocEndpointCheck = ESLintUtils.RuleCreator.withoutDocs( +{ + name: 'jsdoc-endpoint-check', + meta: { + type: 'layout', + docs: { + description: 'Checks that the JSDoc for an endpoint has the correct format', + recommended: 'error' + }, + fixable: 'code', + hasSuggestions: true, + messages: { + firstLineShouldBeEmpty: 'JSDoc first line should be empty', + summaryHasMarkup: 'JSDoc summary should not contain markup', + summaryMissingPeriod: 'JSDoc summary should end with a period', + lineAfterSummaryShouldBeEmpty: 'Line after summary should be empty', + endpointJSDocMissing: 'The JSDoc for an endpoint is missing.', + markdownLintError: 'Markdown error ({{rule}}): {{detail}}' + }, + schema: [ + { + type: 'object', + properties: { + markdownlint: { + type: 'object', + description: 'Configuration object for markdownlint rules', + additionalProperties: true + } + }, + additionalProperties: false + } + ] + }, + defaultOptions: [ + { + markdownlint: { + default: true, + // Disable rules that don't make sense for JSDoc descriptions + 'MD041': false, + 'MD013': false, + 'MD033': false, + 'MD034': false, + 'MD047': false, + 'MD036': false, + 'MD040': false + } + } + ], + create(context) { + const sourceCode = context.sourceCode || context.getSourceCode() + const options = context.options[0] || {} + const markdownlintConfig = options.markdownlint || context.options[0]?.markdownlint || { + default: true, + 'MD041': false, + 'MD013': false, + 'MD033': false, + 'MD034': false, + 'MD047': false, + 'MD036': false, + 'MD040': false + } + + return { + 'TSInterfaceDeclaration, ClassDeclaration'(node) { + if (node.id.name !== 'Request') return + + const nodeToGetCommentsFrom = + node.parent?.type === 'ExportNamedDeclaration' ? node.parent : node + + const comments = sourceCode.getCommentsBefore(nodeToGetCommentsFrom) + const jsdoc = comments + ?.filter(comment => comment.type === 'Block' && comment.value.startsWith('*')) + .pop() + + if (!jsdoc) { + context.report({ node, messageId: 'endpointJSDocMissing' }) + return + } + + const validationErrors = validateJSDoc(jsdoc, markdownlintConfig) + validationErrors.forEach(({ messageId, data, line, column, canFix }) => { + context.report({ + node, + messageId, + ...(data && { data }), + loc: { start: { line, column } }, + ...(canFix && { fix: createJSDocFixer(jsdoc, messageId) }), + ...(canFix && { suggestions: [createJSDocFixer(jsdoc, messageId)] }) + }) + }) + } + } + } +}) + +export default jsdocEndpointCheck \ No newline at end of file diff --git a/validator/test/jsdoc-endpoint-check.test.js b/validator/test/jsdoc-endpoint-check.test.js new file mode 100644 index 0000000000..0196e304fa --- /dev/null +++ b/validator/test/jsdoc-endpoint-check.test.js @@ -0,0 +1,438 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RuleTester } from '@typescript-eslint/rule-tester' +import jsdocEndpointCheck from '../rules/jsdoc-endpoint-check.js' + +const ruleTester = new RuleTester({ + languageOptions: { + parserOptions: { + projectService: { + allowDefaultProject: ['*.ts*'], + }, + tsconfigRootDir: import.meta.dirname, + }, + }, +}) + +const rule = jsdocEndpointCheck + +ruleTester.run('jsdoc-endpoint-check', rule, { + valid: [ + { + name: 'valid', + code: `/** + * Get aliases. + * + * Get the cluster's index aliases, including filter and routing information. + * This API does not return data stream aliases. + * IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. + * @rest_spec_name cat.aliases + * @availability stack stability=stable + * @availability serverless stability=stable visibility=public + * @doc_id cat-alias + * @index_privileges view_index_metadata + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +}` + }, + { + name: 'description contains escaped newlines', + code: `/** + * Get aliases. + * + * Get the cluster's index aliases, including filter and routing information. + * This API does not return data stream aliases.\\n + * IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. + * @rest_spec_name cat.aliases + * @availability stack stability=stable + * @availability serverless stability=stable visibility=public + * @doc_id cat-alias + * @index_privileges view_index_metadata + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +` + }, + { + name: 'summary has `_`', + code: `/** + * Update the connector is_native flag. + * + * @rest_spec_name connector.update_native + * @availability stack since=8.12.0 stability=beta + * @availability serverless stability=beta visibility=public + * @doc_id connector-update-native + */ +export interface Request {}` + }, + { + name: 'last line can be empty', + code: `/** + * Get aliases. + * + * Get the cluster's index aliases, including filter and routing information. + * @rest_spec_name cat.aliases + * @doc_id cat-alias + * + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +` + }, + ], + invalid: [ + { + name: 'no first line empty', + code: `/** Get aliases. + * + * Get the cluster's index aliases, including filter and routing information. + * This API does not return data stream aliases. + * IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. + * @rest_spec_name cat.aliases + * @availability stack stability=stable + * @availability serverless stability=stable visibility=public + * @doc_id cat-alias + * @index_privileges view_index_metadata + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + output: `/** + * Get aliases. + * + * Get the cluster's index aliases, including filter and routing information. + * This API does not return data stream aliases. + * IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. + * @rest_spec_name cat.aliases + * @availability stack stability=stable + * @availability serverless stability=stable visibility=public + * @doc_id cat-alias + * @index_privileges view_index_metadata + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + errors: [ + { messageId: 'firstLineShouldBeEmpty' } + ] + }, + { + name: 'missing empty line after summary', + code: `/** + * Get aliases. + * Get the cluster's index aliases, including filter and routing information. + * This API does not return data stream aliases. + * IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. + * @rest_spec_name cat.aliases + * @availability stack stability=stable + * @availability serverless stability=stable visibility=public + * @doc_id cat-alias + * @index_privileges view_index_metadata + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + output: `/** + * Get aliases. + * + * Get the cluster's index aliases, including filter and routing information. + * This API does not return data stream aliases. + * IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. + * @rest_spec_name cat.aliases + * @availability stack stability=stable + * @availability serverless stability=stable visibility=public + * @doc_id cat-alias + * @index_privileges view_index_metadata + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + errors: [{ messageId: 'lineAfterSummaryShouldBeEmpty' }] + }, + { + name: 'summary missing period', + code: `/** + * Get aliases + * + * Get the cluster's index aliases, including filter and routing information. + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + output: `/** + * Get aliases. + * + * Get the cluster's index aliases, including filter and routing information. + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + errors: [{ messageId: 'summaryMissingPeriod' }] + }, + { + name: 'summary has markup', + code: `/** + * Get \`aliases\`. + * + * Get the cluster's index aliases, including filter and routing information. + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + errors: [{ messageId: 'summaryHasMarkup' }] + }, + { + name: 'missing JSDoc', + code: `export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + errors: [{ messageId: 'endpointJSDocMissing' }] + }, + { + name: 'missing summary', + code: `/** + * Get the cluster's index aliases, including filter and routing information. + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + output: `/** + * Get the cluster's index aliases, including filter and routing information. + * + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request { + urls: [ + { + path: '/_cat/aliases' + methods: ['GET'] + } + ] +} +`, + errors: [{ messageId: 'lineAfterSummaryShouldBeEmpty' }] + }, + { + name: 'invalid markdown - multiple blank lines', + code: `/** + * Get aliases. + * + * This description has multiple blank lines. + * + * + * Another paragraph here. + * + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request {} +`, + errors: [{ messageId: 'markdownLintError' }] + }, + { + name: 'invalid markdown - unordered list style', + code: `/** + * Get aliases. + * + * This API provides: + * * First item + * * Second item + * + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request {} +`, + errors: [{ messageId: 'markdownLintError' }] + }, + { + name: 'invalid markdown - emphasis markers', + code: `/** + * Get aliases. + * + * This uses **bad emphasis** and **another one **. + * + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request {} +`, + errors: [{ messageId: 'markdownLintError' }] + }, + ], +}) + +// Additional tests for custom configuration +ruleTester.run('jsdoc-endpoint-check with custom config', rule, { + valid: [ + { + name: 'custom config - disable MD012 (multiple blank lines)', + code: `/** + * Get aliases. + * + * This description has multiple blank lines. + * + * + * Another paragraph here. + * + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request {} +`, + options: [ + { + markdownlint: { + default: true, + 'MD041': false, + 'MD013': false, + 'MD033': false, + 'MD034': false, + 'MD047': false, + 'MD012': false // Disable multiple blank lines check + } + } + ] + }, + { + name: 'custom config - disable all markdown linting', + code: `/** + * Get aliases. + * + * This has **bad emphasis ** and multiple blanks. + * + * + * Still valid because markdown linting is disabled. + * + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request {} +`, + options: [ + { + markdownlint: { + default: false // Disable all markdownlint rules + } + } + ] + }, + ], + invalid: [ + { + name: 'custom config - default config still catches errors', + code: `/** + * Get aliases. + * + * This description has multiple blank lines. + * + * + * Another paragraph here. + * + * @rest_spec_name cat.aliases + * @doc_id cat-alias + */ +export interface Request {} +`, + // Using default configuration which should catch MD012 + errors: [{ messageId: 'markdownLintError' }] + }, + ], +}) \ No newline at end of file diff --git a/validator/test/no-all-string-literal-unions.js b/validator/test/no-all-string-literal-unions.test.js similarity index 100% rename from validator/test/no-all-string-literal-unions.js rename to validator/test/no-all-string-literal-unions.test.js diff --git a/validator/test/no-duplicate-type-names.js b/validator/test/no-duplicate-type-names.test.js similarity index 100% rename from validator/test/no-duplicate-type-names.js rename to validator/test/no-duplicate-type-names.test.js