From 6b1d2fbfa918431a665ca712ff6a29ce6849578d Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 8 Oct 2024 07:02:34 -0500 Subject: [PATCH] [Docs] Update msearch descriptions (#604) * Update msearch descriptions Signed-off-by: Archer * Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Include additional mterm vectors changes. Signed-off-by: Archer * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Archer Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower --- spec/schemas/_core.msearch.yaml | 38 ++++++++++++------------ spec/schemas/_core.msearch_template.yaml | 10 +++---- spec/schemas/_core.mtermvectors.yaml | 12 ++++---- 3 files changed, 30 insertions(+), 30 deletions(-) diff --git a/spec/schemas/_core.msearch.yaml b/spec/schemas/_core.msearch.yaml index 06c256943..a63678983 100644 --- a/spec/schemas/_core.msearch.yaml +++ b/spec/schemas/_core.msearch.yaml @@ -58,8 +58,8 @@ components: $ref: '_common.yaml#/components/schemas/Fields' docvalue_fields: description: |- - Array of wildcard (*) patterns. The request returns doc values for field - names matching these patterns in the hits.fields property of the response. + An array of wildcard (*) patterns. The request returns document values for field + names matching these patterns in the `hits.fields` property of the response. type: array items: $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat' @@ -72,14 +72,14 @@ components: $ref: '_common.query_dsl.yaml#/components/schemas/KnnQuery' from: description: |- - Starting document offset. By default, you cannot page through more than 10,000 + The starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the - search_after parameter. + `search_after` parameter. type: number highlight: $ref: '_core.search.yaml#/components/schemas/Highlight' indices_boost: - description: Boosts the _score of documents from specified indices. + description: Boosts the `_score` of documents from specified indexes. type: array items: type: object @@ -87,8 +87,8 @@ components: type: number min_score: description: |- - Minimum _score for matching documents. Documents with a lower _score are - not included in the search results. + 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: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' @@ -119,22 +119,22 @@ components: $ref: '_core.search.yaml#/components/schemas/SourceConfig' fields: description: |- - Array of wildcard (*) patterns. The request returns values for field names - matching these patterns in the hits.fields property of the response. + An array of wildcard (*) patterns. The request returns values for field names + matching these patterns in the `hits.fields` property of the response. type: array items: $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat' terminate_after: description: |- - Maximum number of documents to collect for each shard. If a query reaches this - limit, OpenSearch terminates the query early. OpenSearch collects documents - before sorting. Defaults to 0, which does not terminate query execution early. + The maximum number of documents to collect for each shard. If a query reaches this + limit, OpenSearch stops the query early. OpenSearch collects documents + before sorting. Default is `0`, which does not terminate query execution early. type: number stats: description: |- - Stats groups to associate with the search. Each group maintains a statistics - aggregation for its associated searches. You can retrieve these stats using - the indices stats API. + The statistics groups to associate with the search. Each group maintains a statistics + aggregation for its associated searches. You can retrieve these statistics using + the Index Stats API. type: array items: type: string @@ -142,21 +142,21 @@ components: description: |- Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. - Defaults to no timeout. + Default is no timeout. type: string track_scores: - description: If true, calculate and return 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: If true, returns 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: |- - If 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 23a050708..3b6966d0a 100644 --- a/spec/schemas/_core.msearch_template.yaml +++ b/spec/schemas/_core.msearch_template.yaml @@ -14,24 +14,24 @@ components: type: object properties: explain: - description: If `true`, returns detailed information about score calculation as part of each hit. + description: When `true`, returns detailed information about score calculations as part of each hit. type: boolean id: $ref: '_common.yaml#/components/schemas/Id' params: description: |- - Key-value pairs used to replace Mustache variables in the template. + The key-value pairs used to replace any Mustache variables in the template. The key is the variable name. The value is the variable value. type: object additionalProperties: type: object profile: - description: If `true`, the query execution is profiled. + description: When `true`, provides a profile for the query execution. type: boolean source: description: |- - An inline search template. Supports the same parameters as the search API's - request body. Also supports Mustache variables. If no id is specified, this + An inline search template that supports the same parameters as the search API's + request body. Also supports Mustache variables. When no template ID is specified, this parameter is required. type: string diff --git a/spec/schemas/_core.mtermvectors.yaml b/spec/schemas/_core.mtermvectors.yaml index bed09977d..02b168921 100644 --- a/spec/schemas/_core.mtermvectors.yaml +++ b/spec/schemas/_core.mtermvectors.yaml @@ -14,28 +14,28 @@ components: _index: $ref: '_common.yaml#/components/schemas/IndexName' doc: - description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. + description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. type: object fields: $ref: '_common.yaml#/components/schemas/Fields' field_statistics: - description: If `true`, the response includes the document count, sum of document frequencies, and 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' offsets: - description: If `true`, the response includes term offsets. + description: When `true`, the response includes term offsets. type: boolean payloads: - description: If `true`, the response includes term payloads. + description: When `true`, the response includes term payloads. type: boolean positions: - description: If `true`, the response includes term positions. + description: When `true`, the response includes term positions. type: boolean routing: $ref: '_common.yaml#/components/schemas/Routing' term_statistics: - description: If true, the response includes term frequency and document frequency. + description: When `true`, the response includes the term frequency and the document frequency. type: boolean version: $ref: '_common.yaml#/components/schemas/VersionNumber'