[BUG][Java][okhttp-gson] useOneOfDiscriminatorLookup is ignored in validateJsonElement causing multi-match failure when disallowAdditionalPropertiesIfNotPresent=false
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 48/100
Rechercherichtung
Read modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/oneof_model.mustache, especially validateJsonElement(), and compare its discriminator handling with modules/openapi-generator/src/main/resources/Java/libraries/okhttp/oneof_model.mustache. Check the existing Java generator tests for okhttp-gson oneOf validation, then confirm the supplied Cat payload validates through the discriminator mapping when both options are enabled.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
When generating a Java client using the default okhttp-gson library with:
useOneOfDiscriminatorLookup=truedisallowAdditionalPropertiesIfNotPresent=false
Validating a oneOf model payload using validateJsonElement fails with:
IOException: The JSON string is invalid for Pet with oneOf schemas: Cat, Dog. 2 class(es) match the result, expected 1.
Root Cause
In Java/libraries/okhttp-gson/oneof_model.mustache, discriminator lookup logic exists in the Gson TypeAdapter.read() method, allowing deserialization to fast-path directly to the mapped model.
https://github.com/OpenAPITools/openapi-generator/blob/cff025891c06ff5d9680027b7df8fe1e420a2e1d/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/oneof_model.mustache#L137-L160
-
validateJsonElement(JsonElement jsonElement)lacks this discriminator check. It iterates through alloneOfschemas sequentially and incrementsvalidCountfor each schema that passes validation. -
When
disallowAdditionalPropertiesIfNotPresent=false, schemas accept undeclared properties. If branches share required fields (such as the discriminator field itself) while variant-specific fields are optional, a payload intended for one branch (e.g.{"petType":"cat","hunts":true}) is also considered valid by other branches (e.g.Dog, wherebarkis optional andhuntsis treated as an allowed additional property). -
As a result, both
CatandDogvalidate successfully (validCount = 2), triggering thevalidCount != 1error. -
In the newer generic
okhttplibrary (modules/openapi-generator/src/main/resources/Java/libraries/okhttp/oneof_model.mustache), this discriminator check is already implemented insidevalidateJsonElement(). It simply needs to be ported tookhttp-gson.
openapi-generator version
Master / 7.x
OpenAPI declaration file content or url
openapi: 3.0.3
info:
title: OneOf Discriminator Validation Bug
version: 1.0.0
paths:
/pet:
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
responses:
'200':
description: OK
components:
schemas:
Pet:
type: object
discriminator:
propertyName: petType
mapping:
cat: '#/components/schemas/Cat'
dog: '#/components/schemas/Dog'
oneOf:
- $ref: '#/components/schemas/Cat'
- $ref: '#/components/schemas/Dog'
Cat:
type: object
required:
- petType
properties:
petType:
type: string
hunts:
type: boolean
Dog:
type: object
required:
- petType
properties:
petType:
type: string
bark:
type: boolean
Generation Details
Command line used for generation
$ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
-g java \
--library okhttp-gson \
--additional-properties useOneOfDiscriminatorLookup=true,disallowAdditionalPropertiesIfNotPresent=false \
-i spec.yaml \
-o out/
Steps to reproduce
Run the following test against the generated client:
package org.openapitools.client.model;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import org.junit.jupiter.api.Test;
public class PetTest {
@Test
public void testPet() {
String json = "{\"petType\":\"cat\",\"hunts\":true}";
JsonElement element = JsonParser.parseString(json);
assertDoesNotThrow(() -> Pet.validateJsonElement(element));
}
}
Expected behavior
Because useOneOfDiscriminatorLookup=true is configured, Pet.validateJsonElement(element) should inspect the discriminator field petType, resolve the mapping (cat -> Cat), validate only against Cat.validateJsonElement(element), and return without error.
Actual behavior
Pet.validateJsonElement(element) does not check the discriminator. It validates both Cat and Dog. Since additional properties are allowed, both schemas accept the JSON payload, resulting in validCount = 2 and throwing:
java.io.IOException: The JSON string is invalid for Pet with oneOf schemas: Cat, Dog. 2 class(es) match the result, expected 1. Detailed failure message for oneOf schemas: []. JSON: {"petType":"cat","hunts":true}
Suggest a fix
In oneof_model.mustache, add the {{#useOneOfDiscriminatorLookup}} block to validateJsonElement (matching modules/openapi-generator/src/main/resources/Java/libraries/okhttp/oneof_model.mustache):
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
// validate oneOf schemas one by one
int validCount = 0;
ArrayList<String> errorMessages = new ArrayList<>();
{{#useOneOfDiscriminatorLookup}}
{{#discriminator}}
JsonObject jsonObject = jsonElement.getAsJsonObject();
if (jsonObject.get("{{{propertyBaseName}}}") == null) {
throw new IOException("Failed to deserialize as the discriminator field '{{{propertyBaseName}}}' is missing.");
}
String discriminatorValue = jsonObject.get("{{{propertyBaseName}}}").getAsString();
{{#mappedModels}}
if ("{{{mappingName}}}".equals(discriminatorValue)) {
{{{modelName}}}.validateJsonElement(jsonElement);
return;
}
{{/mappedModels}}
{{/discriminator}}
{{/useOneOfDiscriminatorLookup}}
{{#composedSchemas}}
{{#oneOf}}
I'll create a pull request to fix this.
- Vorherrschende Sprache
- Java
- Sterne
- 26.9k
- Forks
- 7.8k
- Ø Merge
- 2 T. 23 Min.
- Gemergte PRs (30 T.)
- 177
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus OpenAPITools/openapi-generator
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Enhancement: Feature
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorEvtl. vergeben @Inf1mum hat das vor 3 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
OpenAPITools/openapi-generator#25724 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayEvtl. vergeben @Inf1mum hat das vor 3 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
OpenAPITools/openapi-generator#25723 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twiceEvtl. vergeben @Inf1mum hat das vor 2 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
OpenAPITools/openapi-generator#25719 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in OpenAPITools/openapi-generator
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
eclipse-tradista/tradista#371 ·
Maintainer antworten meist innerhalb von 1 Tag
-
critical
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
mars-sim/mars-sim#2199 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
primefaces/primefaces#15568 ·
Maintainer antworten meist innerhalb von 1 Tag
-
崩溃日志只按 CRLF 分行Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
PCL-Community/PCL-CE#3872 ·
Maintainer antworten meist innerhalb von 1 Tag