OpenSearch/rest-api-spec/api/termvector.json

84 lines
2.6 KiB
JSON

{
"termvector" : {
"documentation" : "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-termvectors.html",
"methods" : ["GET", "POST"],
"url" : {
"path" : "/{index}/{type}/{id}/_termvector",
"paths" : ["/{index}/{type}/{id}/_termvector"],
"parts" : {
"index" : {
"type" : "string",
"description" : "The index in which the document resides.",
"required" : true
},
"type" : {
"type" : "string",
"description" : "The type of the document.",
"required" : true
},
"id" : {
"type" : "string",
"description" : "The id of the document.",
"required" : true
}
},
"params": {
"term_statistics" : {
"type" : "boolean",
"description" : "Specifies if total term frequency and document frequency should be returned.",
"default" : false,
"required" : false
},
"field_statistics" : {
"type" : "boolean",
"description" : "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.",
"default" : true,
"required" : false
},
"fields" : {
"type" : "list",
"description" : "A comma-separated list of fields to return.",
"required" : false
},
"offsets" : {
"type" : "boolean",
"description" : "Specifies if term offsets should be returned.",
"default" : true,
"required" : false
},
"positions" : {
"type" : "boolean",
"description" : "Specifies if term positions should be returned.",
"default" : true,
"required" : false
},
"payloads" : {
"type" : "boolean",
"description" : "Specifies if term payloads should be returned.",
"default" : true,
"required" : false
},
"preference" : {
"type" : "string",
"description" : "Specify the node or shard the operation should be performed on (default: random).",
"required" : false
},
"routing" : {
"type" : "string",
"description" : "Specific routing value.",
"required" : false
},
"parent": {
"type" : "string",
"description" : "Parent id of documents.",
"required" : false
}
}
},
"body": {
"description" : "Define parameters. See documentation.",
"required" : false
}
}
}