From 02a68afbe4eaf244ff590d367b9f5c85900d8928 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 7 Oct 2024 15:07:21 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/schemas/_core.msearch.yaml | 10 +++++----- spec/schemas/_core.msearch_template.yaml | 2 +- spec/schemas/_core.mtermvectors.yaml | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/spec/schemas/_core.msearch.yaml b/spec/schemas/_core.msearch.yaml index 095dea82..ba8da6ff 100644 --- a/spec/schemas/_core.msearch.yaml +++ b/spec/schemas/_core.msearch.yaml @@ -87,7 +87,7 @@ components: type: number min_score: description: |- - The minimum `_score` for matching documents. Documents with a lower `_score` than the minimum + The minimum `_score` for document matching. Documents with a lower `_score` than the minimum are not included in the search results. type: number post_filter: @@ -133,7 +133,7 @@ components: stats: description: |- The statistics groups to associate with the search. Each group maintains a statistics - aggregation for its associated searches. You can retrieve these stats using + aggregation for its associated searches. You can retrieve these statistics using the Index Stats API. type: array items: @@ -145,18 +145,18 @@ components: Default is no timeout. type: string track_scores: - description: When true, calculates and returns any document scores, even if the scores are not used for sorting. + description: When true, calculates and returns all document scores, even if the scores are not used for sorting. type: boolean track_total_hits: $ref: '_core.search.yaml#/components/schemas/TrackHits' version: - description: When true, returns the document version as part of a hit. + description: When true, returns the document version as part of the hit. type: boolean runtime_mappings: $ref: '_common.mapping.yaml#/components/schemas/RuntimeFields' seq_no_primary_term: description: |- - When true, returns sequence number and primary term of the last modification + When true, returns the sequence number and primary term of the last modification of each hit. See Optimistic concurrency control. type: boolean pit: diff --git a/spec/schemas/_core.msearch_template.yaml b/spec/schemas/_core.msearch_template.yaml index 44bfff0c..3b6966d0 100644 --- a/spec/schemas/_core.msearch_template.yaml +++ b/spec/schemas/_core.msearch_template.yaml @@ -27,7 +27,7 @@ components: additionalProperties: type: object profile: - description: When `true`, gives a profile for the query execution. + description: When `true`, provides a profile for the query execution. type: boolean source: description: |- diff --git a/spec/schemas/_core.mtermvectors.yaml b/spec/schemas/_core.mtermvectors.yaml index 62326a73..cc7a4eb7 100644 --- a/spec/schemas/_core.mtermvectors.yaml +++ b/spec/schemas/_core.mtermvectors.yaml @@ -19,7 +19,7 @@ components: fields: $ref: '_common.yaml#/components/schemas/Fields' field_statistics: - description: When `true`, the response includes the document count, the sum of document frequencies, and the sum of total term frequencies. + description: When `true`, the response includes the document count, the sum of document frequencies, and the sum of term frequencies. type: boolean filter: $ref: '_core.termvectors.yaml#/components/schemas/Filter'