smallrye-open-api icon indicating copy to clipboard operation
smallrye-open-api copied to clipboard

`externalDocs` is not generated when @ExternalDocumentation is used as a class annotation

Open fabiobrz opened this issue 3 months ago • 2 comments

When @ExternalDocumentation is used to annotate a class, the generated OpenAPI documentation does not contain an externalDocs element at root level, as it should based on the related MicroProfile Javadoc: https://github.com/microprofile/microprofile-open-api/blob/main/api/src/main/java/org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.java#L34

See #2385, which adds a test to reproduce such behavior.

fabiobrz avatar Oct 14 '25 17:10 fabiobrz

@MikeEdgar I was experimenting with WildFly when I hit this. Do you know whether it affects Quarkus as well?

fabiobrz avatar Oct 15 '25 15:10 fabiobrz

@fabiobrz , yes I think it does. It appears from a quick look through the code that it's simply not handled at all for cases where it is placed on a REST method or on a REST class. Rather, it's read as a nested annotation only. Thanks for reporting this.

MikeEdgar avatar Oct 15 '25 16:10 MikeEdgar