[BUG][JAVA][native] oneOf without discriminator rejects valid payloads when variant required properties differ
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 20/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- java, openapi
- Domain
- backend-api-design
Research direction
Start with the generated native model templates, especially oneof_model.mustache, and inspect how model constructors and required properties are generated; the report identifies @JsonCreator as a possible approach. Review the linked pull request #25728, which indicates work is already underway. Done means valid payloads deserialize to their matching oneOf variant and payloads missing that variant’s required fields are rejected.
Written by the indexing model from the issue text.
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
With java + library: native, a oneOf of two object schemas without a discriminator cannot deserialize any valid payload when the variants are distinguished by their required properties. Every variant is accepted for every input, so the generated oneOf deserializer always reports more than one match:
Failed deserialization for Author: 2 classes match result, expected 1
The root cause is that the generated native models only have a no-arg constructor and setters. Annotating a field with @JsonProperty(required = true) does not make Jackson reject a missing property, and unknown properties are ignored. The oneOf deserializer in oneof_model.mustache counts a match whenever readValueAs() does not throw, so both object variants match any JSON object — including valid ones.
This is exactly the case where oneOf is resolvable without a discriminator: the required sets are disjoint (subject vs id + domainId), so a JSON Schema validator accepts exactly one variant. The generated client rejects all of them.
openapi-generator version
Reproduced with 7.27.0 and with the latest master before the fix (commit e4370ff1e1f).
This does not appear to be a recent regression; the native oneOf deserializer has counted successful subtype deserializations for a long time. A discriminator works around it, but the spec does not need one (and the real-world spec this was found in does not use one).
OpenAPI declaration file content or url
openapi: 3.0.3
info:
title: oneOf required properties
version: 1.0.0
paths:
/author:
get:
operationId: getAuthor
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Author'
components:
schemas:
Author:
oneOf:
- $ref: '#/components/schemas/ServiceAuthor'
- $ref: '#/components/schemas/UserAuthor'
ServiceAuthor:
type: object
required:
- subject
properties:
subject:
type: string
UserAuthor:
type: object
required:
- id
- domainId
properties:
id:
type: string
domainId:
type: string
Complete standalone repro (spec, Java harness, run script, expected outputs): https://gist.github.com/thorstenhirsch/9d1d931032530c778a414725163f4eca
Generation Details
java -jar openapi-generator-cli-7.27.0.jar generate \
-g java --library native \
-i spec.yaml -o out \
--additional-properties=useJackson3=true,apiPackage=repro.api,modelPackage=repro.model,invokerPackage=repro
Then:
cd out
mvn -q -DskipTests compile
mvn -q dependency:build-classpath -Dmdep.outputFile=cp.txt
cd ..
CP="out/target/classes:$(cat out/cp.txt)"
javac -cp "$CP" -d out Reproduce.java
java -cp "$CP:out" Reproduce
Steps to reproduce
Reproduce.java reads three JSON documents into the generated Author type:
new JsonMapper().readValue("{\"subject\":\"Jane\"}", Author.class);
new JsonMapper().readValue("{\"id\":\"u-1\",\"domainId\":\"acme\"}", Author.class);
new JsonMapper().readValue("{\"id\":\"u-1\"}", Author.class); // must be rejected
Actual result (7.27.0):
FAIL service author (subject only) rejected: Failed deserialization for Author: 2 classes match result, expected 1
FAIL user author (id + domainId) rejected: Failed deserialization for Author: 2 classes match result, expected 1
OK incomplete user author (id only) rejected: Failed deserialization for Author: 2 classes match result, expected 1
RESULT: 2 FAILURE(S)
Expected result:
OK service author (subject only) -> ServiceAuthor
OK user author (id + domainId) -> UserAuthor
OK incomplete user author (id only) rejected: Failed deserialization for Author: 0 classes match result, expected 1
RESULT: ALL OK
With an opt-in @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) constructor that takes the required properties (generateJsonCreator=true in a local patch), the required sets are enforced. Both valid payloads deserialize as the correct variant, and the incomplete payload is rejected with 0 classes match result, expected 1:
OK service author (subject only) -> ServiceAuthor
OK user author (id + domainId) -> UserAuthor
OK incomplete user author (id only) rejected: Failed deserialization for Author: 0 classes match result, expected 1
RESULT: ALL OK
The same required-property enforcement is also relevant for anyOf and for XML (withXml=true), since those deserializers use the same generated model classes. The oneOf-specific multi-match failure above is what this issue reports.
Related issues/PRs
I searched for an existing report for the Java native library, but the closest issues are different:
- #9606:
anyOfwith a discriminator where one schema is a subset of another; that case is genuinely ambiguous and is not fixed by enforcing required properties. - #20545:
jaxrs-spec, where the generated@JsonCreatortakes the union of alloneOffields and therefore rejects valid input. That is the opposite problem and a different library. - #20399:
jersey2, aboutisNullablebeing lost during deserialization, not about subtype matching. - #19577:
jaxrs-spec, required fields are not enforced at all; nooneOf.
Suggest a fix
Enforce required properties while deserializing models, so that a subtype that is missing a required property fails and does not count as a oneOf match. For Jackson this means a @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) constructor whose parameters are the required properties, annotated with @JsonProperty(value = "...", required = true).
For the native library this should be opt-in (e.g. a new generateJsonCreator option) to avoid changing the behavior of existing clients. I have a patch for this, including support for inherited required properties (super(...)), read-only properties and XML annotations, and I will open a PR.
- Dominant language
- Java
- Stars
- 26.9k
- Forks
- 7.8k
- Avg merge
- 2d 23m
- Merged PRs (30d)
- 177
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from OpenAPITools/openapi-generator
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainers usually reply within 1 day
-
Enhancement: Feature
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
OpenAPITools/openapi-generator#25724 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25723 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25719 · 1 comment ·
Maintainers usually reply within 1 day
All issues in OpenAPITools/openapi-generator
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
eclipse-tradista/tradista#371 ·
Maintainers usually reply within 1 day
-
critical
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mars-sim/mars-sim#2199 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
primefaces/primefaces#15568 ·
Maintainers usually reply within 1 day
-
崩溃日志只按 CRLF 分行Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PCL-Community/PCL-CE#3872 ·
Maintainers usually reply within 1 day