How to tell to use format="date" instead of format="date-time"

[CathKilroy]

Hi

I am using version 4.16.0.

In this version the standard format for Date objects, is "date-time". How can I tell the tool to us "date" instead?

Br Casper

[CarstenWickner]

HI @CathKilroy,

The default behavior you're describing comes from a combination of the following two standard Options in your setup:

• Option.ADDITIONAL_FIXED_TYPES
• Option.EXTRA_OPEN_API_FORMAT_VALUES

The "date-time" value is defined here, since the Date class contains also a time portion:

jsonschema-generator/jsonschema-generator/src/main/java/com/github/victools/jsonschema/generator/impl/module/SimpleTypeModule.java

Lines 85 to 88 in dc4662a

	Stream.of(java.time.LocalDateTime.class, java.time.LocalTime.class, java.time.ZonedDateTime.class,
	java.time.OffsetDateTime.class, java.time.OffsetTime.class, java.time.Instant.class,
	java.util.Date.class, java.util.Calendar.class)
	.forEach(javaType -> module.withStringType(javaType, "date-time"));

---

You have a few alternatives here. The simplest ones would be:

1. Keep your setup as-is and override the "date-time" with "date" with a TypeAttributeOverride

configBuilder.forTypesInGeneral()
        .withTypeAttributeOverride(((collectedTypeAttributes, scope, context) -> {
            if (scope.getType().getErasedType() == Date.class) {
                collectedTypeAttributes.put(context.getKeyword(SchemaKeyword.TAG_FORMAT), "date");
            }
        }));

2. Apply an adjusted SimpleTypeModule instead of the one included by the standard Options

configBuilder.with(SimpleTypeModule.forPrimitiveAndAdditionalTypes().withStringType(Date.class, "date"));

3. Remove the Option.EXTRA_OPEN_API_FORMAT_VALUES and take full control over the "format" keyword

One would do that through a StringFormatResolver:

configBuilder.forTypesInGeneral()
    .withStringFormatResolver(scope -> scope.getType().getErasedType() == Date.class ? "date" : null);
// also need to take care of the other standard "format" values then

4. Override the whole subschema for the Date class with a "CustomDefinitionProvider" of your own:

configBuilder.forTypesInGeneral()
        .withCustomDefinitionProvider((javaType, context) -> javaType.getErasedType() == Date.class
                ? new CustomDefinition(context.getGeneratorConfig().createObjectNode()
                        .put(context.getKeyword(SchemaKeyword.TAG_TYPE), context.getKeyword(SchemaKeyword.TAG_TYPE_STRING))
                        .put(context.getKeyword(SchemaKeyword.TAG_FORMAT), "date"),
                        CustomDefinition.DefinitionType.INLINE,
                        CustomDefinition.AttributeInclusion.YES)
                : null
                );

Due to the way the Option.EXTRA_OPEN_API_FORMAT_VALUES is being applied right now, a "StringFormatResolver" cannot override the "format" set in the SimpleTypeModule directly, as it's coming from the custom type definition directly. That could potentially be changed going forward, to also use a "StringFormatResolver" there, which could then be easily overridden.

At the moment number 1 and 2 appear to be the easiest ways to achieve what you want.