Multisearch examples and formatting

[hyprstack]

I am using the opensearchJs client to send requests. When looking through the docs there are no examples on how a multisearch query body should be structured in order to use the client correctly.

Does the user need to format the body such that each query needs to be on a single line as defined here or does the client do this formatting if given a normal array of json objects as seen in the example here using the Ruby api for elasticsearch?

Also, if each object needs to be on a single line, could this be achieved by simply doing a JSON.stringify on the object, as in:

[
  JSON.stringify({}),
  JSON.stringify({
      "from": 0,
      "limit": 5,
      "query": {
        "bool": {
          ...
        }
      }
    }
  )
]

i.e. do I need to format the body to

[
  {},
  {"from": 0, "limit": 5, "query": {"query": {"bool": {...}}}}
]

Or could I pass in

[
  {},
  {
    "from": 0,
    "limit": 5,
    "query": {
      "bool": {
        ...
      }
    }
  }
]

[tejeshreddy]

@nhtruong can I take this issue up?

[nhtruong]

@tejeshreddy of course!

[tejeshreddy]

@nhtruong just to check with you, the documentation is expected to be changed to clarify the above queries right?

[nhtruong]

@hyprstack The body that the _msearch endpoint accepts is a string representation of NDJSON (newline deliminated JSON: A collection of JSON objects that are seperated by \n). You can manually do the serialization and turn your array of objects into said string OR you can just pass the array of objects as is to the client.msearch method. The client will detect that it's an array and perform the serialization for you.

@tejeshreddy You can add an entry in guides folder called msearch.md with working examples and instructions.