Apply suggestions from code review

Co-authored-by: Abdon Pijpelink <[email protected]>
elastic · Sep 7, 2023 · 2fd8512 · 2fd8512
1 parent 4540df5
commit 2fd8512
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 10 deletions.
diff --git a/specification/_global/exists/DocumentExistsRequest.ts b/specification/_global/exists/DocumentExistsRequest.ts
@@ -53,7 +53,7 @@ export interface Request extends RequestBase {
      */
     preference?: string
     /**
-     * If true, the request is real-time as opposed to near-real-time.
+     * If `true`, the request is real-time as opposed to near-real-time.
      * @server_default true
      * @doc_id realtime
      */
@@ -69,7 +69,7 @@ export interface Request extends RequestBase {
      */
     routing?: Routing
     /**
-     * True or false to return the _source field or not, or a list of fields to return.
+     * `true` or `false` to return the `_source` field or not, or a list of fields to return.
      */
     _source?: SourceConfigParam
     /**

diff --git a/specification/_global/exists_source/SourceExistsRequest.ts b/specification/_global/exists_source/SourceExistsRequest.ts
@@ -29,7 +29,7 @@ import {
 import { SourceConfigParam } from '@global/search/_types/SourceFilter'
 
 /**
- * Checks if a document is stored in the `source`.
+ * Checks if a document's `_source` is stored.
  * @rest_spec_name exists_source
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=public
@@ -69,7 +69,7 @@ export interface Request extends RequestBase {
      */
     routing?: Routing
     /**
-     * True or false to return the _source field or not, or a list of fields to return.
+     * `true` or `false` to return the `_source` field or not, or a list of fields to return.
      */
     _source?: SourceConfigParam
     /**

diff --git a/specification/_global/get/GetRequest.ts b/specification/_global/get/GetRequest.ts
@@ -46,7 +46,7 @@ export interface Request extends RequestBase {
      */
     preference?: string
     /**
-     * If true, the request is real-time as opposed to near-real-time.
+     * If `true`, the request is real-time as opposed to near-real-time.
      * @server_default true
      * @doc_id realtime
      */

diff --git a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts
@@ -54,8 +54,8 @@ export interface Request extends RequestBase {
      */
     search_type?: SearchType
     /**
-     * If `true`, the response returns hits.total as an integer.
-     * If `false`, it returns hits.total as an object.
+     * If `true`, the response returns `hits.total` as an integer.
+     * If `false`, it returns `hits.total` as an object.
      * @server_default false
      */
     rest_total_hits_as_int?: boolean

diff --git a/specification/_global/reindex_rethrottle/types.ts b/specification/_global/reindex_rethrottle/types.ts
@@ -59,9 +59,6 @@ export class ReindexStatus {
    * The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried.
    */
   retries: Retries
-  /**
-   *
-   */
   throttled?: Duration
   /**
    * Number of milliseconds the request slept to conform to `requests_per_second`.