Skip to content

fix: distinguish between default and example set to null and not set at all #2050 #2286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ewaostrowska merged 1 commit into from
Mar 9, 2026
+1,198 −9
Merged

fix: distinguish between default and example set to null and not set at all #2050 #2286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions ...er-parser-v2-converter/src/main/java/io/swagger/v3/parser/converter/SwaggerConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -786,7 +786,9 @@ private Schema convert(SerializableParameter sp) {

if (sp instanceof AbstractSerializableParameter) {
AbstractSerializableParameter ap = (AbstractSerializableParameter) sp;
schema.setDefault(ap.getDefault());
if (ap.getDefault() != null) {
schema.setDefault(ap.getDefault());
}
}
return schema;
}
Expand Down Expand Up @@ -1163,7 +1165,9 @@ public Parameter convert(io.swagger.models.parameters.Parameter v2Parameter) {

if (sp instanceof AbstractSerializableParameter) {
AbstractSerializableParameter ap = (AbstractSerializableParameter) sp;
schema.setDefault(ap.getDefault());
if (ap.getDefault() != null) {
schema.setDefault(ap.getDefault());
}
}
}

Expand Down
311 changes: 311 additions & 0 deletions ...parser-v2-converter/src/test/java/io/swagger/parser/test/V2ConverterNullHandlingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,311 @@
package io.swagger.parser.test;

import io.swagger.v3.core.util.Json;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.parser.OpenAPIV3Parser;
import io.swagger.v3.parser.converter.SwaggerConverter;
import org.testng.annotations.Test;

import static org.testng.Assert.*;

/**
* Tests for null handling in Swagger V2 to OpenAPI V3 conversion
*/
public class V2ConverterNullHandlingTest {

@Test
public void testV2ParameterWithoutDefaultNotSetInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths:\n" +
" /test:\n" +
" get:\n" +
" parameters:\n" +
" - name: param1\n" +
" in: query\n" +
" type: string\n" +
" responses:\n" +
" '200':\n" +
" description: OK\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);
System.out.println(Json.pretty(openAPI));

java.util.List<io.swagger.v3.oas.models.parameters.Parameter> params = openAPI.getPaths().get("/test").getGet().getParameters();
assertEquals(params.size(), 1);

Schema schema = params.get(0).getSchema();
assertNotNull(schema);
assertNull(schema.getDefault(), "Default should be null");
assertFalse(schema.getDefaultSetFlag(), "Default should not be set");
}

@Test
public void testV2ParameterWithDefaultPreservedInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths:\n" +
" /test:\n" +
" get:\n" +
" parameters:\n" +
" - name: param1\n" +
" in: query\n" +
" type: string\n" +
" default: 'test'\n" +
" responses:\n" +
" '200':\n" +
" description: OK\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);
System.out.println(Json.pretty(openAPI));
java.util.List<io.swagger.v3.oas.models.parameters.Parameter> params = openAPI.getPaths().get("/test").getGet().getParameters();
assertEquals(params.size(), 1);

Schema schema = params.get(0).getSchema();
assertNotNull(schema);
assertEquals(schema.getDefault(), "test", "Default should be 'test'");
assertTrue(schema.getDefaultSetFlag(), "Default should be set");
}

@Test
public void testV2BodyParameterWithoutDefaultNotSetInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths:\n" +
" /test:\n" +
" post:\n" +
" parameters:\n" +
" - name: body\n" +
" in: body\n" +
" schema:\n" +
" type: object\n" +
" properties:\n" +
" name:\n" +
" type: string\n" +
" responses:\n" +
" '200':\n" +
" description: OK\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);
System.out.println(Json.pretty(openAPI));

io.swagger.v3.oas.models.parameters.RequestBody requestBody = openAPI.getPaths().get("/test").getPost().getRequestBody();
assertNotNull(requestBody);
assertNotNull(requestBody.getContent());
assertFalse(requestBody.getContent().isEmpty());

String mediaType = requestBody.getContent().containsKey("application/json") ? "application/json" : "*/*";
Schema schema = requestBody.getContent().get(mediaType).getSchema();
assertNotNull(schema);
assertNull(schema.getDefault(), "Default should be null");
assertFalse(schema.getDefaultSetFlag(), "Default should not be set");
}

@Test
public void testV2DefinitionWithoutDefaultNotSetInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths: {}\n" +
"definitions:\n" +
" TestModel:\n" +
" type: object\n" +
" properties:\n" +
" name:\n" +
" type: string\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);
System.out.println(Json.pretty(openAPI));

Schema schema = openAPI.getComponents().getSchemas().get("TestModel");
assertNotNull(schema);
assertNull(schema.getDefault(), "Default should be null");
assertFalse(schema.getDefaultSetFlag(), "Default should not be set");
}

@Test
public void testV2PropertyWithDefaultPreservedInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths: {}\n" +
"definitions:\n" +
" TestModel:\n" +
" type: object\n" +
" properties:\n" +
" status:\n" +
" type: string\n" +
" default: 'active'\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);
System.out.println(Json.pretty(openAPI));

Schema schema = openAPI.getComponents().getSchemas().get("TestModel");
assertNotNull(schema);

Schema statusProp = (Schema) schema.getProperties().get("status");
assertNotNull(statusProp);
assertEquals(statusProp.getDefault(), "active", "Default should be 'active'");
assertTrue(statusProp.getDefaultSetFlag(), "Default should be set");
}

@Test
public void testV2ArrayItemsWithoutDefaultNotSetInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths:\n" +
" /test:\n" +
" get:\n" +
" parameters:\n" +
" - name: items\n" +
" in: query\n" +
" type: array\n" +
" items:\n" +
" type: string\n" +
" responses:\n" +
" '200':\n" +
" description: OK\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);
System.out.println(Json.pretty(openAPI));

java.util.List<io.swagger.v3.oas.models.parameters.Parameter> params = openAPI.getPaths().get("/test").getGet().getParameters();
assertEquals(params.size(), 1);

Schema schema = params.get(0).getSchema();
assertNotNull(schema);
assertTrue(schema instanceof io.swagger.v3.oas.models.media.ArraySchema);

io.swagger.v3.oas.models.media.ArraySchema arraySchema =
(io.swagger.v3.oas.models.media.ArraySchema) schema;
assertNull(arraySchema.getDefault(), "Default should be null");
assertFalse(arraySchema.getDefaultSetFlag(), "Default should not be set");
}

@Test
public void testV2ExamplePreservedInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths: {}\n" +
"definitions:\n" +
" TestModel:\n" +
" type: object\n" +
" example:\n" +
" name: 'test'\n" +
" properties:\n" +
" name:\n" +
" type: string\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);

Schema schema = openAPI.getComponents().getSchemas().get("TestModel");
assertNotNull(schema);
assertNotNull(schema.getExample(), "Example should be set");
}

@Test
public void testV2PropertyWithoutExampleNotSetInV3() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths: {}\n" +
"definitions:\n" +
" TestModel:\n" +
" type: object\n" +
" properties:\n" +
" name:\n" +
" type: string\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);

Schema schema = openAPI.getComponents().getSchemas().get("TestModel");
assertNotNull(schema);

Schema nameProp = (Schema) schema.getProperties().get("name");
assertNotNull(nameProp);
assertNull(nameProp.getExample(), "Example should be null");
assertFalse(nameProp.getExampleSetFlag(), "Example should not be set");
}

@Test
public void testV2IntegerParameterWithDefault() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths:\n" +
" /test:\n" +
" get:\n" +
" parameters:\n" +
" - name: limit\n" +
" in: query\n" +
" type: integer\n" +
" default: 10\n" +
" responses:\n" +
" '200':\n" +
" description: OK\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);

java.util.List<io.swagger.v3.oas.models.parameters.Parameter> params = openAPI.getPaths().get("/test").getGet().getParameters();
assertEquals(params.size(), 1);

Schema schema = params.get(0).getSchema();
assertNotNull(schema);
assertEquals(schema.getDefault(), 10, "Default should be 10");
assertTrue(schema.getDefaultSetFlag(), "Default should be set");
}

@Test
public void testV2BooleanParameterWithDefault() {
String v2Yaml = "swagger: '2.0'\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths:\n" +
" /test:\n" +
" get:\n" +
" parameters:\n" +
" - name: verbose\n" +
" in: query\n" +
" type: boolean\n" +
" default: false\n" +
" responses:\n" +
" '200':\n" +
" description: OK\n";

OpenAPI openAPI = new SwaggerConverter().readContents(v2Yaml, null, null).getOpenAPI();
assertNotNull(openAPI);

java.util.List<io.swagger.v3.oas.models.parameters.Parameter> params = openAPI.getPaths().get("/test").getGet().getParameters();
assertEquals(params.size(), 1);

Schema schema = params.get(0).getSchema();
assertNotNull(schema);
assertEquals(schema.getDefault(), false, "Default should be false");
assertTrue(schema.getDefaultSetFlag(), "Default should be set");
}
}
2 changes: 0 additions & 2 deletions modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2994,8 +2994,6 @@ at the moment path passed as string (basePath) from upper components can be both
if (defaultObject != null) {
schema.setDefault(defaultObject);
}
} else {
schema.setDefault(null);
}

Map<String, Object> extensions = getExtensions(node);
Expand Down
12 changes: 8 additions & 4 deletions modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/ResolverFully.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,10 @@ public Schema resolveSchema(Schema schema) {
aggregateSchemaCombinators(composedSchema, combinedModel, composedSchema.getAnyOf(), examples, defaultValues);
}
if (defaultValues.size() == 1) {
combinedModel.setDefault(defaultValues.iterator().next());
Object defaultValue = defaultValues.iterator().next();
if (defaultValue != null) {
combinedModel.setDefault(defaultValue);
}
}

if (schema.getExample() != null) {
Expand Down Expand Up @@ -600,10 +603,11 @@ private void aggregateSchemaCombinators(ComposedSchema sourceSchema, Schema targ
if (resolved.getExample() != null) {
examples.add(resolved.getExample());
}
if (sourceSchema.getDefault() != null && resolved.getDefault() == null)
defaultValues.add(sourceSchema.getDefault());
else
if (resolved.getDefault() != null) {
defaultValues.add(resolved.getDefault());
} else if (sourceSchema.getDefault() != null) {
defaultValues.add(sourceSchema.getDefault());
}

if (resolved.getExtensions() != null) {
Map<String, Object> extensions = resolved.getExtensions();
Expand Down
Loading
Loading