Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

spec/schemas/_core.reindex.yaml

@@ -34,7 +34,7 @@ components:
         size:
           description: |-
             The number of documents to index per batch.
-            Use the `size` setting when indexing from a remote cluster. This ensures that batches fit inside the on-heap buffer. The buffer defaults to a maximum size of `100MB`.
+            Use the `size` setting when indexing from a remote cluster. This ensures that batches fit in the on-heap buffer. The buffer defaults to a maximum size of `100MB`.
           type: number
         slice:
           $ref: '_common.yaml#/components/schemas/SlicedScroll'

spec/schemas/_core.reindex_rethrottle.yaml

@@ -67,7 +67,7 @@ components:
           description: The number of documents that were ignored because the script used for the reindex and returned a `noop` value for `ctx.op`.
           type: number
         requests_per_second:
-          description: The number of successful requests per second during the reindex.
+          description: The number of successful requests per second during the reindex operation.
           type: number
         retries:
           $ref: '_common.yaml#/components/schemas/Retries'

spec/schemas/_core.scripts_painless_execute.yaml

@@ -10,7 +10,7 @@ components:
       type: object
       properties:
         document:
-          description: A document that's temporarily indexed in-memory and accessible from the painless script.
+          description: A document temporarily indexed in-memory and accessible from the Painless script.
           type: object
         index:
           $ref: '_common.yaml#/components/schemas/IndexName'

spec/schemas/_core.search.yaml

@@ -10,7 +10,7 @@ components:
       type: object
       properties:
         total:
-          description: The total hit count information, present only if `track_total_hits` wasn't set to `false` in the search request.
+          description: The total hit count information, present only if `track_total_hits` is not set to `false` in the search request.
           oneOf:
             - $ref: '#/components/schemas/TotalHits'
             - type: integer
@@ -642,15 +642,15 @@ components:
         The number of hits matching the query. When `true`, the exact
         number of hits is returned at the cost of some performance. When `false`, the
         response does not include the total number of hits matching the query.
-        Default is `10,000` hits
+        Default is `10,000` hits.
       oneOf:
         - type: boolean
         - type: integer
           format: int32
     SourceConfigParam:
       description: |-
         Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
-        Use this setting when a query parameter along with the `_source_includes` and `_source_excludes` parameters.
+        Use this setting with the `_source_includes` and `_source_excludes` parameters.
       oneOf:
         - type: boolean
         - $ref: '_common.yaml#/components/schemas/Fields'
@@ -664,7 +664,7 @@ components:
           type: integer
           format: int32
         from:
-          description: The inner hit starting document offset.
+          description: The inner hit that initiates document offset.
           type: integer
           format: int32
         collapse:
@@ -761,7 +761,7 @@ components:
         boundary_scanner_locale:
           description: |-
             Controls which locale is used to search for sentence and word boundaries.
-            This parameter takes the form of a language tag, for example, `"en-US"`, `"fr-FR"`, `"ja-JP"`.
+            This parameter takes the form of a language tag, for example, `"en-US"`, `"fr-FR"`, or `"ja-JP"`.
           type: string
         force_source:
           deprecated: true
@@ -782,8 +782,8 @@ components:
         max_analyzed_offset:
           description: |-
             If set to a non-negative value, highlighting stops at this defined maximum limit.
-            The rest of the text is not processed, not highlighted, and no error is returned.
-            The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to a lower value than the query setting.
+            The rest of the text is not processed or highlighted, and no error is returned.
+            The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which takes precedent when it is set to a lower value than the query setting.
           type: integer
           format: int32
         no_match_size:
@@ -795,7 +795,7 @@ components:
             The maximum number of fragments to return.
             When the number of fragments is set to `0`, no fragments are returned.
             Instead, the entirety of a field's contents are highlighted and returned.
-            This is useful when you need to highlight short texts such as a title or address, but fragmentation is not required.
+            This is useful when you need to highlight short texts, such as a title or address, in which fragmentation is not required.
             If `number_of_fragments` is set to `0`, the `fragment_size` is ignored.
           type: integer
           format: int32
@@ -809,7 +809,7 @@ components:
           description: |-
             Controls the number of matching phrases in a document that are considered.
             This prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
-            When using `matched_fields`, phrase limited phrases per matched field are considered. Raising the limit increases the query time and consumes more memory.
+            When using `matched_fields`, phrase-limited phrases per matched field are considered. Raising the limit increases the query time and consumes more memory.
             This setting is only supported by the `fvh` highlighter.
           type: integer
           format: int32
@@ -899,11 +899,11 @@ components:
         rescore_query:
           $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
         query_weight:
-          description: The relative importance of the original query versus the rescore query.
+          description: The relative importance of the original query as compared to the rescore query.
           type: number
           format: float
         rescore_query_weight:
-          description: The relative importance of the rescore query versus the original query.
+          description: The relative importance of the rescore query as compared to the original query.
           type: number
           format: float
         score_mode:
@@ -922,7 +922,7 @@ components:
       type: object
       properties:
         text:
-          description: The global suggest text, to avoid repetition when the same text is used in several suggesters
+          description: The global suggest text, which avoids repetition when the same text is used in several suggesters.
           type: string
     PointInTimeReference:
       type: object

spec/schemas/_core.termvectors.yaml

@@ -11,21 +11,21 @@ components:
       properties:
         max_doc_freq:
           description: |-
-            Ignore words which occur in more than the number of docs indicated.
-            Default is unbounded.
+            Ignores words that appear in more than the specified number of documents.
+            Default is `unbounded`.
           type: number
         max_num_terms:
-          description: The maximum number of terms that must be returned per field.
+          description: The maximum number of terms that should be returned per field.
           type: number
         max_term_freq:
           description: |-
             Ignore words with more than this frequency in the source doc.
-            Default is unbounded.
+            Default is `unbounded`.
           type: number
         max_word_length:
           description: |-
             The maximum word length above which words will be ignored.
-            Default is unbounded.
+            Default is `unbounded`.
           type: number
         min_doc_freq:
           description: Ignore terms which do not occur in at least this many docs.