chore: add new JSDoc endpoint check rule (#5677)

* chore: add new JSDoc endpoint check rule

* chore: `npm run lint --prefix specification -- --fix`

* doc: fix missing ` in validator/README/md

* chore: prettier

* chore: disable currently failing markdown lint errors in JSDocs

Author: MattDevy

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