opensearch-project / opensearch-project/opensearch-java

[FEATURE] allow setting an arbitrary json property on any level of any API request objects

Open
#379 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Java
Stars
165
Forks
250
Avg merge
1d 18h
Merged PRs (30d)
26

Description

Is your feature request related to a problem?

Current Java API doesn't contain definition of 'mapping' object within org.opensearch.client.opensearch.indices.IndexSettings and doesn't allow a non-declared json field to be added to the payload

What solution would you like?

Either add mapping.totalFields.limit properties chain to IndexSettings object or consider allowing setting an arbitrary json property on any level of any API request objects

What alternatives have you considered?

Using high-level rest client as a workaround

Do you have any additional context?

Nope

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with org.opensearch.client.opensearch.indices.IndexSettings and inspect how Java API request objects represent and serialize nested properties. Compare the requested mapping.totalFields.limit path with the existing high-level REST client workaround; done means that path, or arbitrary undeclared JSON properties at any request level, can be represented in the Java client payload.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.