Subtype loses allOf reference to its polymorphic parent since 3.2.0 when a controller repeats the interface's @Valid on a @RequestBody
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 30/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- java, openapi, spring, spring-boot
- Domaine
- api, documentation
Piste de recherche
Start in GenericParameterService.resolveTypeAndTypeAnnotationsForParameter, where annotations of the parameter's AnnotatedType were added in ada02a095, and compare with DelegatingMethodParameter.getTypeUseAnnotations. The proposed filter is to drop type-use annotations already present among the parameter annotations, so the context-annotation cache key for createCat matches updateCat again. Reproduce first with the attached test.org.springdoc.api.v31.app283 fixture in springdoc-openapi-starter-webmvc-api, asserting Cat is emitted as allOf with a $ref to Animal. Note an open pull request already exists, so coordinate before starting.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Describe the bug
After upgrading from 3.1.1 to 3.2.0, subtypes of a @JsonSubTypes parent are documented as flat object schemas instead of allOf: [{$ref: Parent}, {…}]. If all subtypes are affected, the parent schema is then unreferenced and removed by removeBrokenReferenceDefinitions (with springdoc.remove-broken-reference-definitions=false it is still there, but nothing references it).
The trigger is a controller method that implements an interface method and repeats the interface's @Valid on the @RequestBody parameter:
interface CatApi {
@PostMapping("/cats")
void createCat(@Valid @RequestBody Cat cat);
}
@RestController
public class HelloController implements CatApi {
@Override
public void createCat(@Valid Cat cat) { } // removing @Valid here restores the 3.1.1 output
}
To Reproduce
- Spring Boot: 4.1.1
- springdoc-openapi:
springdoc-openapi-starter-webmvc-ui3.2.0 (works with 3.1.1) - swagger-core: 2.2.55 (same in both versions)
springdoc.api-docs.version=OPENAPI_3_1
A test case for springdoc-openapi-starter-webmvc-api is attached (test.org.springdoc.api.v31.app283, two files). HelloController contains:
Animal: abstract,@JsonSubTypes(Cat), and its subtypeCatCatApi:PUT /catsandPOST /cats, both with@Valid @RequestBody Cat;POST /catsalso declares@ApiResponse(content = @Content(schema = @Schema(implementation = Cat.class)))updateCatwithout parameter annotations,createCatrepeating@ValidPOST /petswith@RequestBody AnimalandGET /cats/countreturning aString
Expected behavior
"Cat": {
"allOf": [
{ "$ref": "#/components/schemas/Animal" },
{ "type": "object", "properties": { "indoor": { "type": "boolean" } } }
]
}
Actual behavior
Cat is a flat object schema containing all properties (name, indoor) and no allOf.
Analysis
The behaviour changed with ada02a095 (#3377, "honour JSpecify @Nullable on controller parameters"). GenericParameterService.resolveTypeAndTypeAnnotationsForParameter now also forwards the annotations of the parameter's AnnotatedType itself. @Valid (like @NotNull) also targets TYPE_USE, so for createCat the request body is resolved with the context annotations [RequestBody, Valid, Valid] instead of [RequestBody, Valid]. The type-use annotations are read from the implementation method, while the parameter annotations are merged with the interface's, so updateCat keeps the old key and createCat gets a new one.
Because the ModelConverterContext is shared for the whole document build (SpringDocAnnotationsUtils.MODEL_CONVERTER_CONTEXT_MAP) and AnnotatedType.equals compares the context annotations, this new key leads to the following sequence (operations are processed in reverse RequestMappingInfo order):
PUT /cats:Catis resolved flat.POST /pets: resolvingAnimalmakesModelResolver.resolveSubtypesredefineCatasallOfschema in the shared context.POST /cats, request body: 3.1.1 hits the cache. 3.2.0 has a new key, soModelResolverresolvesCatagain anddefineModelreplaces theallOfschema with a flat one in the shared context.POST /cats, response:AnnotationsUtils.getSchemaresolvesCatin a fresh context andcomponents.addSchemasoverwrites the component with a flat schema.GET /cats/count:SpringDocAnnotationsUtils.extractSchemamerges all models of the shared context into the components and prefers schemas withallOf. In 3.1.1 this restores theallOfversion ofCat; in 3.2.0 the shared context only holds the flat one.
Possible fix
Skip type annotations that are already present among the parameter annotations before merging them, as DelegatingMethodParameter.getTypeUseAnnotations already does with !declaredAnnotations.contains(annotation). That keeps the cache keys of 3.1.1 for declaration-and-type-use annotations like @Valid/@NotNull, while type-use-only annotations such as JSpecify's @Nullable are still forwarded.
The underlying fragility is older, though: any resolution of a subtype under a new cache key after its parent has been resolved replaces the allOf form with a flat schema in the shared context, and whether the final document is correct then depends on operation order.
- Langage dominant
- Java
- Étoiles
- 3.7k
- Forks
- 605
- Merge moyen
- 4 j 18 h
- PR mergées (30 j)
- 21
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de springdoc/springdoc-openapi
-
Add support for OpenAPI spec 3.2Ouverteenhancement upstream
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
springdoc/springdoc-openapi#3324 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
enhancement upstream
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
springdoc/springdoc-openapi#3309 · 4 commentaires · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de springdoc/springdoc-openapi
Issues similaires
-
Keyboard crashes Chrome tabsOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 73/100
Julow/Unexpected-Keyboard#1490 ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
Vakore/ZappierGames#275 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
unitycatalog/unitycatalog#2148 ·
Les mainteneurs répondent en général sous 2 jours
-
enhancement priority: low
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
Riptide-Labs/riptide#1060 ·
Les mainteneurs répondent en général sous 1 jour
-
bug key bindings source editor
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
Les mainteneurs répondent en général sous 1 jour