Skip to content

Set multipleOf for numbers with @Digits, stop generating pattern #2422

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
MikeEdgar merged 2 commits into from
Nov 22, 2025
+292 −234
Merged

Set multipleOf for numbers with @Digits, stop generating pattern #2422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0648c20
Set `multipleOf` for numbers with `@Digits`, stop generating `pattern`
MikeEdgar Nov 21, 2025
6a8d211
Fix formatting, JAX-RS test case
MikeEdgar Nov 21, 2025
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
33 changes: 26 additions & 7 deletions core/src/main/java/io/smallrye/openapi/runtime/scanner/dataobject/BeanValidationScanner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import static org.jboss.jandex.DotName.createComponentized;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
Expand Down Expand Up @@ -258,7 +259,7 @@ private void applyStringConstraints(AnnotationTarget target,
decimalMax(target, schema);
decimalMin(target, schema);
pattern(target, schema);
digits(target, schema);
digitsString(target, schema);
notBlank(target, schema, propertyKey, handler);
notNull(target, propertyKey, handler);
notNullKotlin(target, propertyKey, handler);
Expand Down Expand Up @@ -301,7 +302,7 @@ private void applyNumberConstraints(AnnotationTarget target,
RequirementHandler handler) {
decimalMax(target, schema);
decimalMin(target, schema);
digits(target, schema);
digitsNumber(target, schema);
max(target, schema);
min(target, schema);
negative(target, schema);
Expand Down Expand Up @@ -340,8 +341,8 @@ void decimalMax(AnnotationTarget target, Schema schema) {
} else {
schema.setMaximum(decimal);
}
} catch (@SuppressWarnings("unused") NumberFormatException e) {
DataObjectLogging.logger.invalidAnnotationFormat(decimalValue);
} catch (NumberFormatException e) {
DataObjectLogging.logger.invalidAnnotationFormat(decimalValue, e.getMessage());
}
}
}
Expand All @@ -360,14 +361,14 @@ void decimalMin(AnnotationTarget target, Schema schema) {
} else {
schema.setMinimum(decimal);
}
} catch (@SuppressWarnings("unused") NumberFormatException e) {
DataObjectLogging.logger.invalidAnnotationFormat(decimalValue);
} catch (NumberFormatException e) {
DataObjectLogging.logger.invalidAnnotationFormat(decimalValue, e.getMessage());
}
}

}

void digits(AnnotationTarget target, Schema schema) {
void digitsString(AnnotationTarget target, Schema schema) {
AnnotationInstance constraint = getConstraint(target, BV_DIGITS);

if (constraint != null && schema.getPattern() == null) {
Expand Down Expand Up @@ -401,6 +402,24 @@ void digits(AnnotationTarget target, Schema schema) {
}
}

void digitsNumber(AnnotationTarget target, Schema schema) {
AnnotationInstance constraint = getConstraint(target, BV_DIGITS);

if (constraint != null && schema.getMultipleOf() == null) {
// `fraction` attribute is required - safe to use primitive.
final int fractionPart = context.annotations().value(constraint, "fraction");
BigDecimal multipleOf;

if (fractionPart > 0) {
multipleOf = new BigDecimal(BigInteger.ONE, fractionPart);
} else {
multipleOf = BigDecimal.ONE;
}

schema.setMultipleOf(multipleOf);
}
}

void max(AnnotationTarget target, Schema schema) {
AnnotationInstance constraint = getConstraint(target, BV_MAX);

Expand Down
9 changes: 6 additions & 3 deletions core/src/main/java/io/smallrye/openapi/runtime/scanner/dataobject/DataObjectLogging.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package io.smallrye.openapi.runtime.scanner.dataobject;

import static java.lang.invoke.MethodHandles.lookup;

import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
Expand All @@ -13,15 +15,16 @@

@MessageLogger(projectCode = "SROAP", length = 5)
interface DataObjectLogging extends BasicLogger {
DataObjectLogging logger = Logger.getMessageLogger(DataObjectLogging.class, DataObjectLogging.class.getPackage().getName());
DataObjectLogging logger = Logger.getMessageLogger(lookup(), DataObjectLogging.class,
DataObjectLogging.class.getPackage().getName());

@LogMessage(level = Logger.Level.DEBUG)
@Message(id = 6000, value = "Processing @Schema annotation %s on a field %s")
void processingFieldAnnotation(AnnotationInstance annotation, String propertyKey);

@LogMessage(level = Logger.Level.DEBUG)
@Message(id = 6001, value = "Annotation value has invalid format: %s")
void invalidAnnotationFormat(String decimalValue);
@Message(id = 6001, value = "Annotation value has invalid format: %s. Exception: %s")
void invalidAnnotationFormat(String decimalValue, String exceptionMessage);

@LogMessage(level = Logger.Level.DEBUG)
@Message(id = 6002, value = "Possible cycle was detected at: %s. Will not search further.")
Expand Down
69 changes: 62 additions & 7 deletions ...c/test/java/io/smallrye/openapi/runtime/scanner/dataobject/BeanValidationScannerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.fail;

import java.io.IOException;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
Expand Down Expand Up @@ -295,11 +297,11 @@ void testJakartaDecimalMaxPrimaryDigits() {

void testDecimalMaxPrimaryDigits(FieldInfo targetField) {
testTarget.decimalMax(targetField, schema);
testTarget.digits(targetField, schema);
testTarget.digitsNumber(targetField, schema);

assertEquals(new BigDecimal("200.00"), schema.getMaximum());
assertEquals(new BigDecimal("0.01"), schema.getMultipleOf());
assertEquals(null, schema.getExclusiveMaximum());
assertEquals("^\\d{1,3}([.]\\d{1,2})?$", schema.getPattern());
}

@Test
Expand Down Expand Up @@ -344,9 +346,9 @@ void testJakartaDecimalMaxExclusiveDigits() {

void testDecimalMaxExclusiveDigits(FieldInfo targetField) {
testTarget.decimalMax(targetField, schema);
testTarget.digits(targetField, schema);
testTarget.digitsNumber(targetField, schema);
assertEquals(new BigDecimal("201.0"), schema.getExclusiveMaximum());
assertEquals("^\\d{1,3}([.]\\d)?$", schema.getPattern());
assertEquals(new BigDecimal("0.1"), schema.getMultipleOf());
}

@Test
Expand Down Expand Up @@ -421,10 +423,10 @@ void testJakartaDecimalMinExclusiveDigits() {

void testDecimalMinExclusiveDigits(FieldInfo targetField) {
testTarget.decimalMin(targetField, schema);
testTarget.digits(targetField, schema);
testTarget.digitsNumber(targetField, schema);

assertEquals(new BigDecimal("9.00"), schema.getExclusiveMinimum());
assertEquals("^\\d([.]\\d{1,2})?$", schema.getPattern());
assertEquals(new BigDecimal("0.01"), schema.getMultipleOf());
}

@Test
Expand Down Expand Up @@ -571,7 +573,7 @@ void testStringNotBlankDigits(FieldInfo targetField) {
Schema parentSchema = OASFactory.createSchema();
String propertyKey = targetField.name();

testTarget.digits(targetField, schema);
testTarget.digitsString(targetField, schema);
testTarget.notBlank(targetField, schema, propertyKey, requirementHandler(parentSchema));

assertEquals("^\\d{1,8}([.]\\d{1,10})?$", schema.getPattern());
Expand Down Expand Up @@ -694,4 +696,57 @@ void testPatternFields(FieldInfo targetField, String expectedPattern) {
testTarget.pattern(targetField, schema);
assertEquals(expectedPattern, schema.getPattern());
}

@Test
void testNumberDigits() throws IOException {
class Numbers {
@jakarta.validation.constraints.Digits(integer = 9, fraction = 0)
int int32;
@jakarta.validation.constraints.Digits(integer = 18, fraction = 0)
int int64;
@jakarta.validation.constraints.Digits(integer = 5, fraction = 3)
float float32;
@jakarta.validation.constraints.Digits(integer = 10, fraction = 6)
double float64;
@jakarta.validation.constraints.Digits(integer = 20, fraction = 10)
BigDecimal decimal;
@jakarta.validation.constraints.Digits(integer = 20, fraction = 0)
BigInteger integer;
@jakarta.validation.constraints.Digits(integer = 20, fraction = 0)
@org.eclipse.microprofile.openapi.annotations.media.Schema(multipleOf = 1000)
BigInteger customInteger;
}

Index index = Index.of(Numbers.class);
ClassInfo numbers = index.getClassByName(Numbers.class);

schema.setMultipleOf(null);
testTarget.digitsNumber(numbers.field("int32"), schema);
assertEquals(BigDecimal.ONE, schema.getMultipleOf());

schema.setMultipleOf(null);
testTarget.digitsNumber(numbers.field("int64"), schema);
assertEquals(BigDecimal.ONE, schema.getMultipleOf());

schema.setMultipleOf(null);
testTarget.digitsNumber(numbers.field("float32"), schema);
assertEquals(new BigDecimal("0.001"), schema.getMultipleOf());

schema.setMultipleOf(null);
testTarget.digitsNumber(numbers.field("float64"), schema);
assertEquals(new BigDecimal("0.000001"), schema.getMultipleOf());

schema.setMultipleOf(null);
testTarget.digitsNumber(numbers.field("decimal"), schema);
assertEquals(new BigDecimal("0.0000000001"), schema.getMultipleOf());

schema.setMultipleOf(null);
testTarget.digitsNumber(numbers.field("integer"), schema);
assertEquals(BigDecimal.ONE, schema.getMultipleOf());

// Normally set by AnnotationTargetProcessor + SchemaFactory
schema.setMultipleOf(new BigDecimal("1000"));
testTarget.digitsNumber(numbers.field("customInteger"), schema);
assertEquals(new BigDecimal("1000"), schema.getMultipleOf());
}
}
Loading