opensearch-project / opensearch-project/data-prepper
Introduce validation mechanism for custom json schema annotation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 374
- Forks
- 355
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
We have introduced some custom annotations for generating json schema for plugins, e.g. @AlsoRequires. However, a validation mechanism has been missing which could lead to misses in specifying correct values
Describe the solution you'd like
Validate plugin config instances against the custom annotations
Describe alternatives you've considered (Optional)
A clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context or screenshots about the feature request here.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the custom JSON schema annotations, including @AlsoRequires, and the code that handles plugin config instances. Determine how those annotations should be validated and define tests covering valid and missing or incorrect values; done means plugin configurations are checked consistently against the annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100