Skip to content

Commit fc06b80

Browse files
committed
[OpenAPI] Edit mget API
1 parent a8d0688 commit fc06b80

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,6 @@ actions:
181181
x-displayName: Script - Get languages
182182
- name: search
183183
x-displayName: Search
184-
- name: msearch
185-
x-displayName: Search - Multi search
186184
- name: scroll
187185
x-displayName: Search - Scroll
188186
- name: terms_enum

specification/_global/msearch/MultiSearchRequest.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,28 @@ import { long } from '@_types/Numeric'
2323
import { RequestItem } from './types'
2424

2525
/**
26+
* Run multiple searches.
27+
*
28+
* The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.
29+
* The structure is as follows:
30+
*
31+
* ```
32+
* header\n
33+
* body\n
34+
* header\n
35+
* body\n
36+
* ```
37+
*
38+
* This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.
39+
*
40+
* IMPORTANT: The final line of data must end with a newline character `\n`.
41+
* Each newline character may be preceded by a carriage return `\r`.
42+
* When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.
2643
* @rest_spec_name msearch
2744
* @availability stack since=1.3.0 stability=stable
2845
* @availability serverless stability=stable visibility=public
2946
* @index_privileges read
47+
* @doc_tag search
3048
*/
3149
export interface Request extends RequestBase {
3250
path_parts: {

0 commit comments

Comments
 (0)