chore: add new JSDoc endpoint check rule

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<TDocument, TPartialDocument> extends RequestBase {
   urls: [

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

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.

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.

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

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

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

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.
  *

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

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

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

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

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.
  *

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

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.

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.

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.

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.

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

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

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

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

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

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.

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.

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.

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.
  *

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.

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

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

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.

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.
  *

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.

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

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.

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:
  *

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

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

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

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

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

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

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

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

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

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

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

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

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