Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for (some) Springdoc annotations in the openapi spring module #1819

Open
phillip-kruger opened this issue Apr 29, 2024 · 6 comments
Open
Labels
enhancement New feature or request

Comments

@phillip-kruger
Copy link
Member

See quarkusio/quarkus#40328

/cc @mrickly

@MikeEdgar - w.d.y.t ?

@MikeEdgar
Copy link
Member

This makes sense to me. Probably best to isolate it to the Spring module.

@phillip-kruger
Copy link
Member Author

@mrickly are you keen to do a PR for this ?

@mrickly
Copy link

mrickly commented Apr 30, 2024

@phillip-kruger : We are open to giving it a try. But we will need some guidance, e.g. the correct location/package for such a change. We would probably start with the ParameterObject and if it works as expected add things as the need arises.

@phillip-kruger
Copy link
Member Author

Ok No worries. Most of the work is done in core (https://github.com/smallrye/smallrye-open-api/tree/main/core) and core then calls out to one of jax-rs, spring or vertx. So this should be done somewhere in spring module (https://github.com/smallrye/smallrye-open-api/tree/main/extension-spring). We just need to see if the "hooks" exist in core. I would assume it will work the same way as BeanParam in jax-rs. (see

BEAN_PARAM(JaxRsConstants.BEAN_PARAM, null, null, null),
). @MikeEdgar, anything to add ?

@MikeEdgar
Copy link
Member

This will likely be in the SpringParameterProcessor. I'm not entirely sure if @ParameterObject is analogous to @BeanParam or is it more like the MP OpenAPI @Parameter (i.e. documentation only, not functional).

@flyinfish
Copy link

Hi @MikeEdgar @phillip-kruger

i posted PR #1823 for @mrickly .

this would solve our needs. situation is somehow "shady" as quarkus does not seem to behave exactly as spring needing @QueryParam on fields while spring does not.

thanks for your review. tell us if you need more tests whatever

@MikeEdgar MikeEdgar added the enhancement New feature or request label May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants