Add duplicate properties to Validation Report

[philkra]

🚀 Feature Proposal

The validation report should contain the information of duplicate properties within a Request. E.g. query_parameters has a property force and so does body in StopDatafeedRequest.

Motivation

Feedback loop with the server team to remove this duplicate parameters.

Example

"duplicateProperties": {
  "StopDatafeedRequest": {
    "force": ["query_parameters", "body"]
  }
}

[swallez]

+1 for the validation report, but not sure we should aim at having them removed in ES. In the case of search for example, this allows the use of GET requests for simple searches (with parameters on the query string) while keeping the ability to have the full query as JSON for more complex cases.

What we need though is a way to know that a query parameter can also be expressed as a body property. In many cases there's a 1:1 mapping, but there are more complex cases like _source_excludes and _source_include query parameters in SearchRequest that can also be expressed as _source.include and _source.exclude in the body.

The approach I've taken in the Java client is to ignore a query property if there's a body property with the same name, or a body property that matches the first word of the request property. In the example above this evicts both _source_excludes and _source_includes.

This text-based matching is a bit brittle though, and could be made more formal with a jstag on query properties indicating that they also exist as body properties, e.g.

/** @also_in_body */
_source_excludes?: Fields
/** @also_in_body */
_source_includes?: Fields