Skip to content

Commit d9004ac

Browse files
committed
[OpenAPI] Edit mget API tag and summary
1 parent a8d0688 commit d9004ac

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,6 @@ actions:
5555
externalDocs:
5656
description: Reading and writing documents
5757
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html
58-
- name: mget
59-
x-displayName: Document - Multi get
6058
- name: mtermvectors
6159
x-displayName: Document - Multi term vectors
6260
- name: delete_by_query_rethrottle

specification/_global/mget/MultiGetRequest.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,16 @@ import { Fields, Ids, IndexName, Routing } from '@_types/common'
2323
import { Operation } from './types'
2424

2525
/**
26+
* Get multiple documents.
27+
*
28+
* Get multiple JSON documents by ID from one or more indices.
29+
* If you specify an index in the request URI, you only need to specify the document IDs in the request body.
30+
* To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.
2631
* @rest_spec_name mget
2732
* @availability stack since=1.3.0 stability=stable
2833
* @availability serverless stability=stable visibility=public
2934
* @index_privileges read
35+
* @doc_tag document
3036
*/
3137
export interface Request extends RequestBase {
3238
path_parts: {

0 commit comments

Comments
 (0)