[elasticsearch-api] Mismatch between documentation and behaviour in Elasticsearch::API::Actions#create

[janko]

The documentation for Elasticsearch::API::Actions#create says for the :id parameter:

Document ID (optional, will be auto-generated if missing)

However, the :id parameter is actually required:

elasticsearch-ruby/elasticsearch-api/lib/elasticsearch/api/actions/create.rb

Lines 29 to 32 in 698065a

	def create(arguments={})
	raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
	index arguments.update :op_type => 'create'
	end

So either the documentation needs to be corrected or the :id shouldn't be required. I'm hoping for the latter, as id shouldn't be required by Elasticsearch when creating documents directly.

[karmi]

Right, there's some kind of mismatch. I can see that I've added that specific verification in the last commit, and the Elasticsearch's REST API specification lists the parameter as required:true... I'll check what's up with the requirement.

[karmi]

I've fixed the method in the attached commit and verified it manually against ES 6.x and master. Many thanks for bringing it to my attention, @janko-m!

---

Verification

curl localhost:9250 | jq '.version.number'

"7.0.0-alpha1"

curl -H 'Content-Type: application/json' -X POST localhost:9250/test/doc?op_type=create -d '{"title":"test"}'

{"error":# {"root_cause":[# {"type":"action_request_validation_exception","reason":"Validation Failed: 1: an id must be provided if version type or value are set;"}],"type":"action_request_validation_exception","reason":"Validation Failed: 1: an id must be provided if version type or value are set;"},"status":400}

curl -H 'Content-Type: application/json' -X POST localhost:9250/test/doc/1?op_type=create -d '{"title":"test"}'

{"_index":"test","_type":"doc","_id":"1","_version":1,"result":"created","_shards":# {"total":2,"successful":2,"failed":0},"_seq_no":0,"_primary_term":1}

curl -H 'Content-Type: application/json' -X PUT localhost:9250/test/doc/1?op_type=create -d '{"title":"test"}'

{"error":# {"root_cause":[# {"type":"version_conflict_engine_exception","reason":"[doc][1]: version conflict, document already exists (current version [1])","index_uuid":"u_hk8__eTiC3fSjIarlIiQ","shard":"4","index":"test"}],"type":"version_conflict_engine_exception","reason":"[doc][1]: version conflict, document already exists (current version [1])","index_uuid":"u_hk8__eTiC3fSjIarlIiQ","shard":"4","index":"test"},"status":409}

curl -H 'Content-Type: application/json' -X POST localhost:9250/test/doc -d '{"title":"test"}'

{"_index":"test","_type":"doc","_id":"qGZgN2EByDMEGVYQkNI4","_version":1,"result":"created","_shards":# {"total":2,"successful":2,"failed":0},"_seq_no":0,"_primary_term":1}

curl localhost:9200 | jq '.version.number'

"6.1.2"

curl -H 'Content-Type: application/json' -X POST localhost:9200/test/doc -d '{"title":"test"}'

{"_index":"test","_type":"doc","_id":"kYZpN2EB3Vk5YTrSK5Pn","_version":1,"result":"created","_shards":# {"total":2,"successful":1,"failed":0},"_seq_no":1,"_primary_term":1}

curl -H 'Content-Type: application/json' -X POST localhost:9200/test/doc?op_type=create -d {"title":"test"}

{"error":# {"root_cause":[# {"type":"action_request_validation_exception","reason":"Validation Failed: 1: an id must be provided if version type or value are set;"}],"type":"action_request_validation_exception","reason":"Validation Failed: 1: an id must be provided if version type or value are set;"},"status":400}

curl -H 'Content-Type: application/json' -X PUT localhost:9200/test/doc/1?op_type=create -d '{"title":"test"}'

{"_index":"test","_type":"doc","_id":"1","_version":3,"result":"created","_shards":{"total":2,"successful":2,"failed":0},"_seq_no":2,"_primary_term":1}

curl -H 'Content-Type: application/json' -X PUT localhost:9200/test/doc/1?op_type=create -d '{"title":"test"}'

{"error":{"root_cause":[{"type":"version_conflict_engine_exception","reason":"[doc][1]: version conflict, document already exists (current version [3])","index_uuid":"u_hk8__eTiC3fSjIarlIiQ","shard":"4","index":"test"}],"type":"version_conflict_engine_exception","reason":"[doc][1]: version conflict, document already exists (current version [3])","index_uuid":"u_hk8__eTiC3fSjIarlIiQ","shard":"4","index":"test"},"status":409}

curl -H 'Content-Type: application/json' -X POST localhost:9250/test/doc -d '{"title":"test"}'

{"_index":"test","_type":"doc","_id":"s_iiPGEBLenwa_nplLPj","_version":1,"result":"created","_shards":{"total":2,"successful":2,"failed":0},"_seq_no":0,"_primary_term":1}


[karmi]

I've merged the fix into the master and 6.x and released as part of 6.0.1.