#3314 fix has no effect if swagger-core resolved a schema before `ObjectMapperProvider` was created
Los mantenedores suelen responder en 14 días
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- java, spring-boot
- Área
- backend
Línea de trabajo
Start in ObjectMapperProvider, where the constructor registers SchemaTypeMixin on the shared Json31.mapper(), then follow SpringDocUtils.cloneViaJson and the fallback in AbstractRequestService.applyBeanValidatorAnnotations. Reproduce by creating a bean that calls AnnotationsUtils.resolveSchemaFromType before springdoc auto-configuration, then requesting /v3/api-docs for a constrained parameter. Done when cloning a JsonSchema with types no longer depends on mapper initialization order; run the relevant springdoc tests for OpenAPI 3.1 schema cloning.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Describe the bug
With OpenAPI 3.1, Json Processing Exception occurred: Cannot construct instance of java.util.HashSet … from String value ('string') (through reference chain: io.swagger.v3.oas.models.media.JsonSchema["type"]) is still logged for every parameter with a validation constraint (@Min, @Pattern, @Size, …), although #3314 should have fixed this in 3.1.1. As a consequence, AbstractRequestService.applyBeanValidatorAnnotations falls back to modifying the original, possibly shared schema, which is the case #3270 meant to avoid.
Cause
ObjectMapperProvider registers SchemaTypeMixin on the JVM-wide Json31.mapper() in its constructor. Jackson only applies mixins to deserializers built afterwards, and caches those deserializers.
swagger-core uses the same mapper: ModelResolver copies property schemas via AnnotationsUtils.clone, which reads them back through ModelDeserializer, which in turn calls Json31.mapper().convertValue(node, JsonSchema.class) after removing type from the node. If that happens before ObjectMapperProvider is created, the cached JsonSchema deserializer lacks the TypeSetDeserializer. Every later SpringDocUtils.cloneViaJson fails, because it does not remove type first.
This happens in any application whose own configuration resolves a schema while it is being created. User configuration beans are instantiated before springdoc's auto-configuration. In our case it was an OperationCustomizer bean:
@Bean
public OperationCustomizer errorResponseSchemas(SpringDocConfigProperties properties) {
Schema schema = AnnotationsUtils.resolveSchemaFromType(ApiResponseBody.class, null, null, properties.isOpenapi31());
// …
}
To Reproduce
- Spring Boot: 4.1.1
- springdoc-openapi: 3.1.1 and 3.2.0
- swagger-core: 2.2.55
springdoc.api-docs.version=OPENAPI_3_1(the default)
- A bean in the application's own configuration that calls
AnnotationsUtils.resolveSchemaFromType(SomeDto.class, null, null, true)for a class with properties. - A controller method with a constrained parameter, e.g.
@RequestParam @Min(1) Integer pageSize. - Request
/v3/api-docs: the warning is logged for that parameter.
At that point, objectMapperProvider.jsonMapper() is Json31.mapper() and findMixInClassFor(Schema.class) returns SchemaTypeMixin, yet SpringDocUtils.cloneViaJson of a JsonSchema with types = [integer] falls back to returning the original object. The same clone succeeds in a fresh JVM without the early bean.
Expected behavior
The schema is copied regardless of what used Json31.mapper() before springdoc was initialized.
Workaround
Inject ObjectMapperProvider into the bean that resolves schemas early, so that springdoc configures the mapper first. This makes the warnings disappear in our application.
Possible fix
Don't change the shared Json31.mapper(). Let ObjectMapperProvider configure its own instance instead, e.g. ObjectMapperFactory.createJson31() with SchemaTypeMixin, as createJson already does for the standalone mappers. Alternatively, swagger-core could make the 3.1 type property readable back in the form it writes it (swagger-api/swagger-core#5264), which would make the mixin unnecessary.
- Lenguaje dominante
- Java
- Estrellas
- 3.7k
- Forks
- 605
- Merge medio
- 12 d 22 h
- PR fusionados (30 d)
- 10
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de springdoc/springdoc-openapi
-
`ConcurrentModificationException` in `SchemaPropertyDeprecatingConverter.isDeprecated`, and `DEPRECATED_ANNOTATIONS` gains a duplicate on every context startPosiblemente ocupada @awinishere la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
springdoc/springdoc-openapi#3400 ·
Los mantenedores suelen responder en 14 días
-
Property type "null" is missing if Kotlin property name does not equal OpenAPI property nameAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 66/100
springdoc/springdoc-openapi#3399 · 1 comentario ·
Los mantenedores suelen responder en 14 días
-
Dificultad 4/5 3-5 días Aptitud para principiantes 57/100
springdoc/springdoc-openapi#3398 ·
Los mantenedores suelen responder en 14 días
-
Subtype loses allOf reference to its polymorphic parent since 3.2.0 when a controller repeats the interface's @Valid on a @RequestBodyPosiblemente ocupada @jochenberger la tomó hace 8 días. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 30/100
springdoc/springdoc-openapi#3393 ·
Los mantenedores suelen responder en 14 días
-
Dificultad 3/5 1-2 días Aptitud para principiantes 54/100
springdoc/springdoc-openapi#3374 · 2 comentarios ·
Los mantenedores suelen responder en 14 días
Todos los issues de springdoc/springdoc-openapi
Issues similares
-
needs-area-label
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
Los mantenedores suelen responder en 2 días
-
enhancement Java macOS
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
freerouting/freerouting#1079 ·
Los mantenedores suelen responder en 4 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
apache/maven-enforcer#1074 ·
Los mantenedores suelen responder en 1 día
-
Gradle liquibaseDiffChangelog drops jhi_date_time_wrapperPosiblemente ocupada @mraible la tomó hoy. Abiertoarea: triage theme: undefined
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
jhipster/generator-jhipster#35998 ·
Los mantenedores suelen responder en 1 día