opensearch-project / opensearch-project/opensearch-java

[FEATURE] Allow deserializing request class that have required path parameters

Open
#1,359 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem?

Currently it is impossible to deserialize a request class from JSON when it has required path parameters as they will not be set and a missing property exception will be thrown.

What solution would you like?

A mechanism to pass additional context into the deserialization that can carry the path parameter values separately to the JSON blob.

What alternatives have you considered?

Deserializing the path params out of the JSON blob.

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

No files, tests, or entry points are named. Start by locating request-class JSON deserialization and the handling of required path parameters, then determine how separate path context should flow into it. Done means a request with required path parameters can be deserialized without a missing-property exception, with coverage for the chosen context mechanism.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.