chore: apply npm run lint --prefix specification -- --fix

Author: MattDevy

specification/_global/bulk/BulkRequest.ts

@@ -31,22 +31,18 @@ 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.
- *
- * If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
  *
+ * Perform multiple `index`, `create`, `delete`, and `update` actions in a single request.
+ * This reduces overhead and can greatly increase indexing speed.\n
+ * If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n
  * * To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.
  * * To use the `index` action, you must have the `create`, `index`, or `write` index privilege.
  * * To use the `delete` action, you must have the `delete` or `write` index privilege.
  * * To use the `update` action, you must have the `index` or `write` index privilege.
  * * To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.
- * * To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.
- *
- * Automatic data stream creation requires a matching index template with data stream enabled.
- *
- * The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:
- *
+ * * To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n
+ * Automatic data stream creation requires a matching index template with data stream enabled.\n
+ * The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n
  * ```
  * action_and_meta_data\n
  * optional_source\n
@@ -55,93 +51,65 @@ import { OperationContainer, UpdateAction } from './types'
  * ....
  * action_and_meta_data\n
  * optional_source\n
- * ```
- *
+ * ```\n
  * The `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.
  * A `create` action fails if a document with the same ID already exists in the target
- * An `index` action adds or replaces a document as necessary.
- *
+ * An `index` action adds or replaces a document as necessary.\n
  * NOTE: Data streams support only the `create` action.
- * To update or delete a document in a data stream, you must target the backing index containing the document.
- *
- * An `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.
- *
- * A `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.
- *
+ * To update or delete a document in a data stream, you must target the backing index containing the document.\n
+ * An `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n
+ * A `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n
  * NOTE: The final line of data must end with a newline character (`\n`).
  * Each newline character may be preceded by a carriage return (`\r`).
  * When sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.
- * Because this format uses literal newline characters (`\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.
- *
- * If you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.
- *
+ * Because this format uses literal newline characters (`\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n
+ * If you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n
  * A note on the format: the idea here is to make processing as fast as possible.
- * As some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.
- *
- * Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.
- *
+ * As some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n
+ * Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n
  * There is no "correct" number of actions to perform in a single bulk request.
  * Experiment with different settings to find the optimal size for your particular workload.
  * Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.
  * It is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.
- * For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.
- *
- * **Client suppport for bulk requests**
- *
- * Some of the officially supported clients provide helpers to assist with bulk requests and reindexing:
- *
+ * For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n
+ * **Client suppport for bulk requests**\n
+ * Some of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n
  * * Go: Check out `esutil.BulkIndexer`
  * * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`
  * * Python: Check out `elasticsearch.helpers.*`
  * * JavaScript: Check out `client.helpers.*`
  * * .NET: Check out `BulkAllObservable`
  * * PHP: Check out bulk indexing.
- * * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
- *
- * **Submitting bulk requests with cURL**
- *
+ * * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`\n
+ * **Submitting bulk requests with cURL**\n
  * If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.
- * The latter doesn't preserve newlines. For example:
- *
+ * The latter doesn't preserve newlines. For example:\n
  * ```
  * $ cat requests
  * { "index" : { "_index" : "test", "_id" : "1" } }
  * { "field1" : "value1" }
  * $ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo
  * {"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]}
- * ```
- *
- * **Optimistic concurrency control**
- *
+ * ```\n
+ * **Optimistic concurrency control**\n
  * Each `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.
- * The `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.
- *
- * **Versioning**
- *
+ * The `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n
+ * **Versioning**\n
  * Each bulk item can include the version value using the `version` field.
  * It automatically follows the behavior of the index or delete operation based on the `_version` mapping.
- * It also support the `version_type`.
- *
- * **Routing**
- *
+ * It also support the `version_type`.\n
+ * **Routing**\n
  * Each bulk item can include the routing value using the `routing` field.
- * It automatically follows the behavior of the index or delete operation based on the `_routing` mapping.
- *
- * NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.
- *
- * **Wait for active shards**
- *
- * When making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.
- *
- * **Refresh**
- *
- * Control when the changes made by this request are visible to search.
- *
+ * It automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n
+ * NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n
+ * **Wait for active shards**\n
+ * When making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.\n
+ * **Refresh**\n
+ * Control when the changes made by this request are visible to search.\n
  * NOTE: Only the shards that receive the bulk request will be affected by refresh.
  * Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.
  * The request will only wait for those three shards to refresh.
- * The other two shards that make up the index do not participate in the `_bulk` request at all.
- *
+ * The other two shards that make up the index do not participate in the `_bulk` request at all.\n
  * You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.
  * Refer to the linked documentation for step-by-step instructions using the index settings API.
  * @rest_spec_name bulk
@@ -150,7 +118,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,13 +30,11 @@ import { Operator } from '@_types/query_dsl/Operator'
 
 /**
  * Count search results.
- * Get the number of documents matching a query.
  *
+ * Get the number of documents matching a query.\n
  * The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.
- * The query is optional. When no query is provided, the API uses `match_all` to count all the documents.
- *
- * The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.
- *
+ * The query is optional. When no query is provided, the API uses `match_all` to count all the documents.\n
+ * The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.\n
  * The operation is broadcast across all shards.
  * For each shard ID group, a replica is chosen and the search is run against it.
  * This means that replicas increase the scalability of the count.