in: query
name: query
description: >-
  A search query string with support for more advanced queries using the
  [Elasticsearch Query DSL format](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax).

  Results are sorted by Elasticsearch relevance score.

  ### Search Tips

    * Use `limit` to return more than the default number of 10 results.
    * Be careful to escape any [reserved characters](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters)
      using a backslash (`\`) that are not contained within quotes (`"`). See **Reserved Characters** below.
    * Use quotes (`"`) to return matches that include the phrase exactly. Ex: Search for `"Whitney Houston"` and
      omit results like `Whitney Phillips`.
    * Check out some of the examples below for basic operations.
    * Refer to the [Elasticsearch Query String Syntax documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax)
    * `total_count` indicates the total result count. Has the Elasticsearch configured limit by `index.max_result_window` param. Defaults to 10000.

  #### Reserved Characters

  The following characters must be escaped if they are part of the item you are searching for:

  `+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /`
examples:
  'blink 182':
    value: 'blink 182'
  'ac dc':
    value: 'ac dc'
  '(blink 182) AND (ac dc)':
    value: '(blink 182) AND (ac dc)'
  '"blink 182" + "ac dc"':
    value: '"blink 182" + "ac dc"'
  '(the chainsmokers) AND NOT (coldplay)':
    value: '(the chainsmokers) AND NOT (coldplay)'
  '(the chainsmokers) -coldplay':
    value: '(the chainsmokers) -coldplay'
  'shu bi dua':
    value: 'shu bi dua'
  'shu\-bi\-dua':
    value: 'shu\-bi\-dua'
required: true
schema:
  type: string