Skip to content

fix: adjust docs about RequiredMode.AUTO + small refactor #4982

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
merged 1 commit into from
Oct 6, 2025
Merged

fix: adjust docs about RequiredMode.AUTO + small refactor #4982

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
7 changes: 5 additions & 2 deletions modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,11 @@

/**
* Allows to specify the required mode (RequiredMode.AUTO, REQUIRED, NOT_REQUIRED)
*
* RequiredMode.AUTO: will let the library decide based on its heuristics.
* RequiredMode.AUTO: the library decides using heuristics:
* - Bean Validation / nullability annotations (@NotNull, @NonNull, @NotBlank, @NotEmpty) - required
* - Optional - not required
* - Primitive types (int, boolean, etc.) - not required unless annotated
* - Other object fields without any constraints - not required
* RequiredMode.REQUIRED: will force the item to be considered as required regardless of heuristics.
* RequiredMode.NOT_REQUIRED: will force the item to be considered as not required regardless of heuristics.
*
Expand Down
38 changes: 1 addition & 37 deletions modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/ModelResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2092,43 +2092,7 @@ private boolean resolveSubtypes(Schema model, BeanDescription bean, ModelConvert
ComposedSchema composedSchema = null;
if (!(subtypeModel instanceof ComposedSchema)) {
// create composed schema
// TODO #2312 - smarter way needs clone implemented in #2227
composedSchema = (ComposedSchema) new ComposedSchema()
.title(subtypeModel.getTitle())
.name(subtypeModel.getName())
.deprecated(subtypeModel.getDeprecated())
.additionalProperties(subtypeModel.getAdditionalProperties())
.description(subtypeModel.getDescription())
.discriminator(subtypeModel.getDiscriminator())
.exclusiveMaximum(subtypeModel.getExclusiveMaximum())
.exclusiveMinimum(subtypeModel.getExclusiveMinimum())
.externalDocs(subtypeModel.getExternalDocs())
.format(subtypeModel.getFormat())
.maximum(subtypeModel.getMaximum())
.maxItems(subtypeModel.getMaxItems())
.maxLength(subtypeModel.getMaxLength())
.maxProperties(subtypeModel.getMaxProperties())
.minimum(subtypeModel.getMinimum())
.minItems(subtypeModel.getMinItems())
.minLength(subtypeModel.getMinLength())
.minProperties(subtypeModel.getMinProperties())
.multipleOf(subtypeModel.getMultipleOf())
.not(subtypeModel.getNot())
.nullable(subtypeModel.getNullable())
.pattern(subtypeModel.getPattern())
.properties(subtypeModel.getProperties())
.readOnly(subtypeModel.getReadOnly())
.required(subtypeModel.getRequired())
.type(subtypeModel.getType())
.uniqueItems(subtypeModel.getUniqueItems())
.writeOnly(subtypeModel.getWriteOnly())
.xml(subtypeModel.getXml())
.extensions(subtypeModel.getExtensions());

if (subtypeModel.getExample() != null || subtypeModel.getExampleSetFlag()) {
composedSchema.example(subtypeModel.getExample());
}
composedSchema.setEnum(subtypeModel.getEnum());
composedSchema = ComposedSchema.from(subtypeModel);
} else {
composedSchema = (ComposedSchema) subtypeModel;
}
Expand Down
3 changes: 3 additions & 0 deletions modules/swagger-core/src/test/java/io/swagger/v3/core/converting/ModelPropertyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ public void testReadOnlyProperty() {
public void testRequiredProperty() {
final Map<String, Schema> models = ModelConverters.getInstance().readAll(RequiredFields.class);
Schema model = models.get("RequiredFields");
assertFalse(model.getRequired().contains("optionalField"));
assertFalse(model.getRequired().contains("primitiveTypeWithoutConstraint"));
assertTrue(model.getRequired().contains("primitiveTypeWithConstraint"));
assertTrue(model.getRequired().contains("required"));
assertFalse(model.getRequired().contains("notRequired"));
assertTrue(model.getRequired().contains("notRequiredWithAnnotation"));
Expand Down
11 changes: 11 additions & 0 deletions modules/swagger-core/src/test/java/io/swagger/v3/core/oas/models/RequiredFields.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import io.swagger.v3.oas.annotations.media.Schema;

import javax.validation.constraints.NotNull;
import java.util.Optional;

public class RequiredFields {
@Schema(description = "required", required = true)
Expand All @@ -11,10 +12,20 @@ public class RequiredFields {
@Schema(description = "not required")
public Long notRequired;

@Schema(description = "Optional field")
public Optional<Long> optionalField;

@Schema(description = "not required with annotation")
@NotNull
public Long notRequiredWithAnnotation;

@Schema(description = "primitive type without constraint")
public long primitiveTypeWithoutConstraint;

@Schema(description = "primitive type with constraint")
@NotNull
public long primitiveTypeWithConstraint;

@Schema(description = "mode auto", requiredMode = Schema.RequiredMode.AUTO)
public Long modeAuto;

Expand Down
49 changes: 49 additions & 0 deletions modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/ComposedSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,55 @@

public class ComposedSchema extends Schema<Object> {

public static ComposedSchema from(Schema subtypeModel) {
ComposedSchema composedSchema = new ComposedSchema();
copySchemaProperties(composedSchema, subtypeModel);


if (shouldSetExample(subtypeModel)) {
composedSchema.example(subtypeModel.getExample());
}
composedSchema.setEnum(subtypeModel.getEnum());
return composedSchema;
}

private static void copySchemaProperties(ComposedSchema target, Schema source) {
target.title(source.getTitle())
.name(source.getName())
.deprecated(source.getDeprecated())
.additionalProperties(source.getAdditionalProperties())
.description(source.getDescription())
.discriminator(source.getDiscriminator())
.exclusiveMaximum(source.getExclusiveMaximum())
.exclusiveMinimum(source.getExclusiveMinimum())
.externalDocs(source.getExternalDocs())
.format(source.getFormat())
.maximum(source.getMaximum())
.maxItems(source.getMaxItems())
.maxLength(source.getMaxLength())
.maxProperties(source.getMaxProperties())
.minimum(source.getMinimum())
.minItems(source.getMinItems())
.minLength(source.getMinLength())
.minProperties(source.getMinProperties())
.multipleOf(source.getMultipleOf())
.not(source.getNot())
.nullable(source.getNullable())
.pattern(source.getPattern())
.properties(source.getProperties())
.readOnly(source.getReadOnly())
.required(source.getRequired())
.type(source.getType())
.uniqueItems(source.getUniqueItems())
.writeOnly(source.getWriteOnly())
.xml(source.getXml())
.extensions(source.getExtensions());
}


private static boolean shouldSetExample(Schema model) {
return model.getExample() != null || model.getExampleSetFlag();
}

@Override
public String toString() {
Expand Down
Loading