[v5] UpdateResponse doesn't match the actual response json from elasticsearch.

[yizha]

Please use the following questions as a guideline to help me answer
your issue/question without further inquiry. Thank you.

Which version of Elastic are you using?

[ ] elastic.v2 (for Elasticsearch 1.x)
[ ] elastic.v3 (for Elasticsearch 2.x)
[X] elastic.v5 (for Elasticsearch 5.x)

Please describe the expected behavior

UpdateResponse struct should match the response from Elasticsearch v5.4, but it doesn't now.

UpdateResponse definition from update.go:

// UpdateResponse is the result of updating a document in Elasticsearch.
type UpdateResponse struct {
	Index     string     `json:"_index"`
	Type      string     `json:"_type"`
	Id        string     `json:"_id"`
	Version   int        `json:"_version"`
	Created   bool       `json:"created"`
	GetResult *GetResult `json:"get"`
}

Actual response from Elasticsearch v5.4

{
  "_index": "test",
  "_type": "test",
  "_id": "AVyP-TFcWnJHS5P8SKUK",
  "_version": 3,
  "result": "updated",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  }
}

Please describe the actual behavior

UpdateResponse struct should look like:

type UpdateResponse struct {
	Index     string     `json:"_index"`
	Type      string     `json:"_type"`
	Id        string     `json:"_id"`
	Version   int        `json:"_version"`
	Result    string     `json:"result"`
}

Any steps to reproduce the behavior?

N/A.

[olivere]

Yes, that structure changed recently. I will change it to reflect the current version. Thanks.

[olivere]

The returned structures for Update and Delete in ES 5.4.1 are actually:

// UpdateResponse is the result of updating a document in Elasticsearch.
type UpdateResponse struct {
	Index         string      `json:"_index"`
	Type          string      `json:"_type"`
	Id            string      `json:"_id"`
	Version       int         `json:"_version"`
	Shards        *shardsInfo `json:"_shards"`
	Result        bool        `json:"string,omitempty"`
	ForcedRefresh bool        `json:"forced_refresh,omitempty"`
	GetResult     *GetResult  `json:"get,omitempty"`
}

// DeleteResponse is the outcome of running DeleteService.Do.
type DeleteResponse struct {
	Index         string      `json:"_index"`
	Type          string      `json:"_type"`
	Id            string      `json:"_id"`
	Version       int64       `json:"_version"`
	Shards        *shardsInfo `json:"_shards"`
	Result        bool        `json:"string,omitempty"`
	ForcedRefresh bool        `json:"forced_refresh,omitempty"`
	Found         bool        `json:"found"`
}

I will fix that in 5.0.41.

[olivere]

Ref: e3b7c0

[claudiuolteanu]

Can you please detail why the Result field from DeleteResponse and UpdateResponse is represented as a boolean? From what I saw in the documentation of ES 5.4.1 it is represented as a string and its possible values are represented in this enum:
https://github.com/elastic/elasticsearch/blob/5.4/core/src/main/java/org/elasticsearch/action/DocWriteResponse.java#L64
Here you can find the implementation of UpdateResponse class which extends the DocWriteResponse:
https://github.com/elastic/elasticsearch/blob/v5.4.1/core/src/main/java/org/elasticsearch/action/update/UpdateResponse.java#L35

If we represent the Result field as bool, it will alway be False.

[olivere]

@claudiuolteanu It's clearly wrong for UpdateResponse. But for DeleteResponse, it is correct.

Thanks for addressing this. Maybe you can write a PR?

Tracked in #599

[claudiuolteanu]

Can you please take a look at #600 ? thanks

[olivere]

@claudiuolteanu I already did. However, I need to find some time first. I hope to work on Elastic this weekend, and include some of the outstanding PRs.

[claudiuolteanu]

Ok, thanks. If I can help you with something, please let me know.

Have a nice week