Skip to content

fix: add support for Positive, PositiveOrZero, Negative, and NegativeOrZero validation constraints #5162

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

Open
daniel-kmiecik wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: add support for Positive, PositiveOrZero, Negative, and NegativeOrZero validation constraints #5162

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
44 changes: 44 additions & 0 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 @@ -68,10 +68,14 @@
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.Negative;
import javax.validation.constraints.NegativeOrZero;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Positive;
import javax.validation.constraints.PositiveOrZero;
import javax.validation.constraints.Size;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
Expand Down Expand Up @@ -1898,6 +1902,34 @@ protected boolean applyBeanValidatorAnnotations(Schema property, Annotation[] an
modified = ValidationAnnotationsUtils.applyEmailConstraint(property, email) || modified;
}
}
if (annos.containsKey(JAVAX_POSITIVE)) {
Positive positive = (Positive) annos.get(JAVAX_POSITIVE);
boolean apply = checkGroupValidation(positive.groups(), invocationGroups, acceptNoGroups);
if (apply) {
modified = ValidationAnnotationsUtils.applyPositiveConstraint(property) || modified;
}
}
if (annos.containsKey(JAVAX_POSITIVE_OR_ZERO)) {
PositiveOrZero positiveOrZero = (PositiveOrZero) annos.get(JAVAX_POSITIVE_OR_ZERO);
boolean apply = checkGroupValidation(positiveOrZero.groups(), invocationGroups, acceptNoGroups);
if (apply) {
modified = ValidationAnnotationsUtils.applyPositiveOrZeroConstraint(property) || modified;
}
}
if (annos.containsKey(JAVAX_NEGATIVE)) {
Negative negative = (Negative) annos.get(JAVAX_NEGATIVE);
boolean apply = checkGroupValidation(negative.groups(), invocationGroups, acceptNoGroups);
if (apply) {
modified = ValidationAnnotationsUtils.applyNegativeConstraint(property) || modified;
}
}
if (annos.containsKey(JAVAX_NEGATIVE_OR_ZERO)) {
NegativeOrZero negativeOrZero = (NegativeOrZero) annos.get(JAVAX_NEGATIVE_OR_ZERO);
boolean apply = checkGroupValidation(negativeOrZero.groups(), invocationGroups, acceptNoGroups);
if (apply) {
modified = ValidationAnnotationsUtils.applyNegativeOrZeroConstraint(property) || modified;
}
}
if (validatorProcessor != null && validatorProcessor.getMode().equals(ValidatorProcessor.MODE.AFTER)) {
modified = validatorProcessor.applyBeanValidatorAnnotations(property, annotations, parent, applyNotNullAnnotations) || modified;
}
Expand Down Expand Up @@ -1961,6 +1993,18 @@ protected boolean applyBeanValidatorAnnotationsNoGroups(Schema property, Annotat
Email pattern = (Email) annos.get(JAVAX_EMAIL);
modified = ValidationAnnotationsUtils.applyEmailConstraint(property, pattern) || modified;
}
if (annos.containsKey(JAVAX_POSITIVE)) {
modified = ValidationAnnotationsUtils.applyPositiveConstraint(property) || modified;
}
if (annos.containsKey(JAVAX_POSITIVE_OR_ZERO)) {
modified = ValidationAnnotationsUtils.applyPositiveOrZeroConstraint(property) || modified;
}
if (annos.containsKey(JAVAX_NEGATIVE)) {
modified = ValidationAnnotationsUtils.applyNegativeConstraint(property) || modified;
}
if (annos.containsKey(JAVAX_NEGATIVE_OR_ZERO)) {
modified = ValidationAnnotationsUtils.applyNegativeOrZeroConstraint(property) || modified;
}
return modified;
}

Expand Down
38 changes: 38 additions & 0 deletions modules/swagger-core/src/main/java/io/swagger/v3/core/util/ValidationAnnotationsUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ public class ValidationAnnotationsUtils {
public static final String JAVAX_DECIMAL_MAX = "javax.validation.constraints.DecimalMax";
public static final String JAVAX_PATTERN = "javax.validation.constraints.Pattern";
public static final String JAVAX_EMAIL = "javax.validation.constraints.Email";
public static final String JAVAX_POSITIVE = "javax.validation.constraints.Positive";
public static final String JAVAX_POSITIVE_OR_ZERO = "javax.validation.constraints.PositiveOrZero";
public static final String JAVAX_NEGATIVE = "javax.validation.constraints.Negative";
public static final String JAVAX_NEGATIVE_OR_ZERO = "javax.validation.constraints.NegativeOrZero";

private static final String SCHEMA_EMAIL_FORMAT_NAME = "email";

Expand Down Expand Up @@ -177,4 +181,38 @@ public static boolean applyEmailConstraint(Schema schema, Email annotation) {
return false;
}

public static boolean applyPositiveConstraint(Schema schema) {
if (isNumberSchema(schema)) {
schema.setMinimum(BigDecimal.ZERO);
schema.setExclusiveMinimum(true);
return true;
}
return false;
}

public static boolean applyPositiveOrZeroConstraint(Schema schema) {
if (isNumberSchema(schema)) {
schema.setMinimum(BigDecimal.ZERO);
return true;
}
return false;
}

public static boolean applyNegativeConstraint(Schema schema) {
if (isNumberSchema(schema)) {
schema.setMaximum(BigDecimal.ZERO);
schema.setExclusiveMaximum(true);
return true;
}
return false;
}

public static boolean applyNegativeOrZeroConstraint(Schema schema) {
if (isNumberSchema(schema)) {
schema.setMaximum(BigDecimal.ZERO);
return true;
}
return false;
}

}
49 changes: 49 additions & 0 deletions modules/swagger-core/src/test/java/io/swagger/v3/core/oas/models/BeanValidationsModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@
import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.Negative;
import javax.validation.constraints.NegativeOrZero;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Positive;
import javax.validation.constraints.PositiveOrZero;
import javax.validation.constraints.Size;
import java.math.BigDecimal;
import java.util.List;
import java.util.Optional;

Expand Down Expand Up @@ -40,6 +45,18 @@ public class BeanValidationsModel {

protected Integer birthYear;

@Positive
protected BigDecimal positiveAmount;

@PositiveOrZero
protected BigDecimal positiveOrZeroAmount;

@Negative
protected BigDecimal negativeAmount;

@NegativeOrZero
protected BigDecimal negativeOrZeroAmount;

@Size(min = 2, max = 10)
private List<@Size(min = 3, max = 4) String> items;

Expand Down Expand Up @@ -117,6 +134,38 @@ public void setBirthYear(Integer birthYear) {
this.birthYear = birthYear;
}

public BigDecimal getPositiveAmount() {
return positiveAmount;
}

public void setPositiveAmount(BigDecimal positiveAmount) {
this.positiveAmount = positiveAmount;
}

public BigDecimal getPositiveOrZeroAmount() {
return positiveOrZeroAmount;
}

public void setPositiveOrZeroAmount(BigDecimal positiveOrZeroAmount) {
this.positiveOrZeroAmount = positiveOrZeroAmount;
}

public BigDecimal getNegativeAmount() {
return negativeAmount;
}

public void setNegativeAmount(BigDecimal negativeAmount) {
this.negativeAmount = negativeAmount;
}

public BigDecimal getNegativeOrZeroAmount() {
return negativeOrZeroAmount;
}

public void setNegativeOrZeroAmount(BigDecimal negativeOrZeroAmount) {
this.negativeOrZeroAmount = negativeOrZeroAmount;
}

public List<String> getItems() {
return items;
}
Expand Down
14 changes: 14 additions & 0 deletions modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/BeanValidatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,19 @@ public void readBeanValidatorTest() {
final StringSchema optionalValue = (StringSchema) properties.get("optionalValue");
assertEquals((int) optionalValue.getMinLength(), 1);
assertEquals((int) optionalValue.getMaxLength(), 10);

final NumberSchema positiveAmount = (NumberSchema) properties.get("positiveAmount");
assertEquals(positiveAmount.getMinimum(), BigDecimal.ZERO);
assertTrue(positiveAmount.getExclusiveMinimum());

final NumberSchema positiveOrZeroAmount = (NumberSchema) properties.get("positiveOrZeroAmount");
assertEquals(positiveOrZeroAmount.getMinimum(), BigDecimal.ZERO);

final NumberSchema negativeAmount = (NumberSchema) properties.get("negativeAmount");
assertEquals(negativeAmount.getMaximum(), BigDecimal.ZERO);
assertTrue(negativeAmount.getExclusiveMaximum());

final NumberSchema negativeOrZeroAmount = (NumberSchema) properties.get("negativeOrZeroAmount");
assertEquals(negativeOrZeroAmount.getMaximum(), BigDecimal.ZERO);
}
}
Loading