[Docs] Edit msearch parameters descriptions (#618)

* Edit msearch parameters descriptions Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Oct 17, 2024 · 4c48c26 · 4c48c26
1 parent 99bc701
commit 4c48c26
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/spec/schemas/_core.msearch.yaml b/spec/schemas/_core.msearch.yaml
@@ -47,10 +47,10 @@ components:
  query:
  $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
  explain:
- description: If true, returns detailed information about score computation as part of a hit.
+ description: When `true`, returns detailed information about score computation as part of a hit.
  type: boolean
  ext:
- description: Configuration of search extensions defined by OpenSearch plugins.
+ description: The configuration of search extensions defined by OpenSearch plugins.
  type: object
  additionalProperties:
  type: object
@@ -73,13 +73,13 @@ components:
  from:
  description: |-
  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
+ hits using the `from` and `size` parameters. To page through more than 10,000 hits, use the
  `search_after` parameter.
  type: number
  highlight:
  $ref: '_core.search.yaml#/components/schemas/Highlight'
  indices_boost:
- description: Boosts the `_score` of documents from specified indexes.
+ description: Boosts the `_score` of documents from the specified indexes.
  type: array
  items:
  type: object
@@ -101,7 +101,7 @@ components:
  items:
  $ref: '_core.search.yaml#/components/schemas/Rescore'
  script_fields:
- description: Retrieve a script evaluation (based on different fields) for each hit.
+ description: Retrieves a script evaluation (based on different fields) for each hit.
  type: object
  additionalProperties:
  $ref: '_common.yaml#/components/schemas/ScriptField'
@@ -110,8 +110,8 @@ components:
  size:
  description: |-
  The number of hits to return. 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.
+ than 10,000 hits using the `from` and `size` parameters. To page through more
+ hits, use the `search_after` parameter.
  type: number
  sort:
  $ref: '_common.yaml#/components/schemas/Sort'
@@ -145,18 +145,18 @@ components:
  Default is no timeout.
  type: string
  track_scores:
- description: When true, calculates and returns all 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 the 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 the 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
@@ -14,13 +14,13 @@ components:
  type: object
  properties:
  explain:
- description: When `true`, returns detailed information about score calculations as part of each hit.
+ description: When `true`, returns detailed information about score calculation as part of each hit.
  type: boolean
  id:
  $ref: '_common.yaml#/components/schemas/Id'
  params:
  description: |-
- The key-value pairs used to replace any Mustache variables in the template.
+ The key-value pairs used to replace Mustache variables in the template.
  The key is the variable name.
  The value is the variable value.
  type: object
@@ -31,7 +31,7 @@ components:
  type: boolean
  source:
  description: |-
- 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
+ An inline search template that supports the same parameters as the Search API's
+ request body and Mustache variables. If no `id` is specified, this
  parameter is required.
  type: string