Updated the 1.4 rest api spec for termvector so that it reflects 'Ter…

…m Vectors: Support for artificial documents #7530'
elastic · Dec 12, 2014 · b8803ee · b8803ee
1 parent 24d5ec1
commit b8803ee
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 11 deletions.
diff --git a/rest-api-spec/api/mtermvectors.json b/rest-api-spec/api/mtermvectors.json
@@ -13,11 +13,7 @@
         "type" : {
           "type" : "string",
           "description" : "The type of the document."
-        },
-        "id" : {
-           "type" : "string",
-           "description" : "The id of the document."
-         }
+        }
       },
       "params" : {
         "ids" : {
@@ -78,7 +74,7 @@
       }
     },
     "body" : {
-        "description" : "Define ids, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.",
+        "description" : "Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.",
         "required" : false
 
     }

diff --git a/rest-api-spec/api/termvector.json b/rest-api-spec/api/termvector.json
@@ -3,8 +3,8 @@
     "documentation" : "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-termvectors.html",
     "methods" : ["GET", "POST"],
     "url" : {
-      "path" : "/{index}/{type}/{id}/_termvector",
-      "paths" : ["/{index}/{type}/{id}/_termvector"],
+      "path" : "/{index}/{type}/_termvector",
+      "paths" : ["/{index}/{type}/_termvector", "/{index}/{type}/{id}/_termvector"],
       "parts" : {
         "index" : {
          "type" : "string",
@@ -18,8 +18,7 @@
         },
         "id" : {
            "type" : "string",
-           "description" : "The id of the document.",
-           "required" : true
+           "description" : "The id of the document, when not specified a doc param should be supplied."
          }
       },
       "params": {
@@ -76,7 +75,7 @@
       }
     },
     "body": {
-      "description" : "Define parameters. See documentation.",
+      "description" : "Define parameters and or supply a document to get termvectors for. See documentation.",
       "required" : false
     }
   }