elastic / elastic/elasticsearch-specification

Add duplicate properties to Validation Report

Open
#299 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
158
Forks
136
Avg merge
19h 48m
Merged PRs (30d)
54

Description

## 🚀 Feature Proposal

The [validation report](https://github.com/elastic/elastic-client-generator/blob/master/output/schema/validation-errors.json) should contain the information of duplicate properties within a Request. E.g. `query_parameters` has a property `force` and so does `body` in [StopDatafeedRequest](https://github.com/elastic/elastic-client-generator/blob/master/specification/specs/x_pack/machine_learning/stop_datafeed/StopDatafeedRequest.ts#L25).

## Motivation

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

## Example

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

Contributor guide

Open the contributing guide

Research direction

Read output/schema/validation-errors.json and the StopDatafeedRequest.ts example first, then trace the validation-report generation entry point. Done means the report records each duplicate property by request, property name, and locations such as query_parameters and body.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.