honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-13 00:15:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added the API definition for getting a document

Browse Source 
The `_mget` API was extracted to a separate file
This commit is contained in:
Karel Minarik 2013-05-26 18:53:39 +02:00
parent 3632c5bd68
commit da4ec58dc3
1 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
rest-api-spec/api/get.json
View File

@ -4,31 +4,48 @@
"methods": ["GET", "HEAD", "POST"], "methods": ["GET", "HEAD", "POST"],
"url": { "url": {
"path": "/{index}/{type}/{id}", "path": "/{index}/{type}/{id}",
"paths": ["/{index}/{type}/{id}", "/{index}/{type}/{id}/_source", "/_mget", "/{index}/_mget", "/{index}/{type}/_mget"], "paths": ["/{index}/{type}/{id}", "/{index}/{type}/{id}/_source"],
"parts": { "parts": {
"id": { "id": {
"type" : "string",
"required" : true,
"description" : "The document ID"
}, },
"index": { "index": {
"type" : "string",
"required" : true,
"description" : "The name of the index"
}, },
"type": { "type": {
"type" : "string",
"required" : true,
"description" : "The type of the document (use `_all` to fetch the first document matching the ID across all types)"
} }
}, },
"params": { "params": {
"fields": { "fields": {
}, "type": "list",
"id": { "description" : "A comma-separated list of fields to return in the response"
}, },
"parent": { "parent": {
"type" : "string",
"description" : "The ID of the parent document"
}, },
"preference": { "preference": {
"type" : "string",
"description" : "Specify the shards the operation should be performed on (default: random shard)"
}, },
"realtime": { "realtime": {
"type" : "boolean",
"description" : "Specify whether to perform the operation in realtime or search mode"
}, },
"refresh": { "refresh": {
"type" : "boolean",
"description" : "Refresh the shard containing the document before performing the operation"
}, },
"routing": { "routing": {
}, "type" : "string",
"type": { "description" : "Specific routing value"
} }
} }
}, },