Cannot add custom description and example for java.time.Duration since v2.8.6. Fixes #2964.

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/SpringDocUtils.java

@@ -27,27 +27,15 @@
 package org.springdoc.core.utils;
 
 import java.lang.annotation.Annotation;
-import java.nio.charset.Charset;
-import java.time.Duration;
-import java.time.LocalTime;
-import java.time.MonthDay;
-import java.time.OffsetTime;
-import java.time.Period;
-import java.time.Year;
-import java.time.YearMonth;
-import java.time.ZoneId;
-import java.time.ZoneOffset;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Locale;
-import java.util.TimeZone;
 import java.util.function.Predicate;
 
 import io.swagger.v3.core.converter.AnnotatedType;
+import io.swagger.v3.core.util.PrimitiveType;
 import io.swagger.v3.oas.models.media.ComposedSchema;
 import io.swagger.v3.oas.models.media.Content;
 import io.swagger.v3.oas.models.media.Schema;
-import io.swagger.v3.oas.models.media.StringSchema;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
@@ -64,6 +52,8 @@
 import org.springframework.core.MethodParameter;
 import org.springframework.util.CollectionUtils;
 
+import static io.swagger.v3.core.util.PrimitiveType.customClasses;
+
 /**
  * The type Spring doc utils.
  *
@@ -537,18 +527,18 @@ public static void handleSchemaTypes(Content content) {
 	 * Init extra schemas.
 	 */
 	public SpringDocUtils initExtraSchemas() {
-		replaceWithSchema(LocalTime.class, new StringSchema().example("14:30:00"));
-		replaceWithSchema(YearMonth.class, new StringSchema().example("2025-03"));
-		replaceWithSchema(MonthDay.class, new StringSchema().example("--03-22"));
-		replaceWithSchema(Year.class, new StringSchema().example("2025"));
-		replaceWithSchema(Duration.class, new StringSchema().example("PT2H30M"));
-		replaceWithSchema(Period.class, new StringSchema().example("P2Y3M"));
-		replaceWithSchema(OffsetTime.class, new StringSchema().example("14:30:00+01:00"));
-		replaceWithSchema(ZoneId.class, new StringSchema().example("Europe/Paris"));
-		replaceWithSchema(ZoneOffset.class, new StringSchema().example("+01:00"));
-		replaceWithSchema(TimeZone.class, new StringSchema().example("GMT"));
-		replaceWithSchema(Charset.class, new StringSchema().example("UTF-8"));
-		replaceWithSchema(Locale.class, new StringSchema().example("en-US"));
+		customClasses().put("java.time.Duration", PrimitiveType.STRING);
+		customClasses().put("java.time.LocalTime", PrimitiveType.STRING);
+		customClasses().put("java.time.YearMonth", PrimitiveType.STRING);
+		customClasses().put("java.time.MonthDay", PrimitiveType.STRING);
+		customClasses().put("java.time.Year", PrimitiveType.STRING);
+		customClasses().put("java.time.Period", PrimitiveType.STRING);
+		customClasses().put("java.time.OffsetTime", PrimitiveType.STRING);
+		customClasses().put("java.time.ZoneId", PrimitiveType.STRING);
+		customClasses().put("java.time.ZoneOffset", PrimitiveType.STRING);
+		customClasses().put("java.util.TimeZone", PrimitiveType.STRING);
+		customClasses().put("java.util.Charset", PrimitiveType.STRING);
+		customClasses().put("java.util.Locale", PrimitiveType.STRING);
 		return this;
 	}
 
@@ -558,10 +548,22 @@ public SpringDocUtils initExtraSchemas() {
 	 * @return the spring doc utils
 	 */
 	public SpringDocUtils resetExtraSchemas() {
-		SpringDocUtils.getConfig().removeFromSchemaMap(LocalTime.class, YearMonth.class,
-				MonthDay.class, Year.class, Duration.class, Period.class, OffsetTime.class,
-				ZoneId.class, ZoneOffset.class, TimeZone.class, Charset.class, Locale.class);
+		customClasses().remove("java.time.Duration");
+		customClasses().remove("java.time.LocalTime");
+		customClasses().remove("java.time.YearMonth");
+		customClasses().remove("java.time.MonthDay");
+		customClasses().remove("java.time.Year");
+		customClasses().remove("java.time.Period");
+		customClasses().remove("java.time.OffsetTime");
+		customClasses().remove("java.time.ZoneId");
+		customClasses().remove("java.time.ZoneOffset");
+		customClasses().remove("java.util.TimeZone");
+		customClasses().remove("java.util.Charset");
+		customClasses().remove("java.util.Locale");
 		return this;
 	}
+
+
 }
 
+

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app243/HelloController.java

@@ -15,12 +15,14 @@
 public class HelloController {
 
 	@PostMapping("/time1")
-	public TimeDtoNoAnnotations postTime1(@RequestBody TimeDtoNoAnnotations timeDto) {
+	public TimeDtoNoAnnotations postTime1(
+			@RequestBody TimeDtoNoAnnotations timeDto) {
 		return timeDto;
 	}
 
-	public record TimeDtoNoAnnotations (LocalDateTime localDateTime, 
-										LocalDate localDate, LocalTime localTime,
-										YearMonth yearMonth, MonthDay monthDay, Year year) {
+	public record TimeDtoNoAnnotations(LocalDateTime localDateTime,
+									   LocalDate localDate, LocalTime localTime,
+									   YearMonth yearMonth, MonthDay monthDay,
+									   Year year) {
 	}
 }

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app115.json

@@ -23,8 +23,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "string",
-                  "example": "PT2H30M"
+                  "type": "string"
                 }
               }
             }

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app243.json

@@ -56,20 +56,16 @@
             "format": "date"
           },
           "localTime": {
-            "type": "string",
-            "example": "14:30:00"
+            "type": "string"
           },
           "yearMonth": {
-            "type": "string",
-            "example": "2025-03"
+            "type": "string"
           },
           "monthDay": {
-            "type": "string",
-            "example": "--03-22"
+            "type": "string"
           },
           "year": {
-            "type": "string",
-            "example": "2025"
+            "type": "string"
           }
         }
       }