diff --git a/rest-api-spec/api/delete.json b/rest-api-spec/api/delete.json index 92169da623f..2bd3bb5c6b8 100644 --- a/rest-api-spec/api/delete.json +++ b/rest-api-spec/api/delete.json @@ -7,28 +7,57 @@ "paths": ["/{index}/{type}/{id}"], "parts": { "id": { + "type" : "string", + "required" : true, + "description" : "The document ID" }, "index": { + "type" : "string", + "required" : true, + "description" : "The name of the index" }, "type": { + "type" : "string", + "required" : true, + "description" : "The type of the document" } }, "params": { "consistency": { + "type" : "enum", + "options" : ["one", "quorum", "all"], + "description" : "Specific write consistency setting for the operation" }, "id": { + "type" : "string", + "description" : "The document ID" }, "parent": { + "type" : "string", + "description" : "ID of parent document" }, "refresh": { + "type" : "boolean", + "description" : "Refresh the index after performing the operation" }, "replication": { + "type" : "enum", + "options" : ["sync","async"], + "default" : "sync", + "description" : "Specific replication type" }, "routing": { + "type" : "string", + "description" : "Specific routing value" }, "timeout": { + "type" : "time", + "description" : "Explicit operation timeout" }, "version_type": { + "type" : "enum", + "options" : ["internal","external"], + "description" : "Specific version type" } } },