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

Quarkus generated OpenAPI documentation for @BeanParam does not reflect inherited parameters #8414

Closed
sean-scott-lr opened this issue Apr 6, 2020 · 9 comments
Labels
Milestone

Comments

@sean-scott-lr
Copy link

Describe the bug
Generated API documentation does not accurately reflect the API for JAX-RS resource method that accept @BeanParam parameters which inherit behaviors from a parent class.

Expected behavior
(Describe the expected behavior clearly and concisely.)

Actual behavior
(Describe the actual behavior clearly and concisely.)

To Reproduce
Steps to reproduce the behavior:

  1. Create a base class which contains an @QueryParam.
  2. Extend that base class with another class and create a JAX-RS resource which accepts it
  3. View the the APIdoc directly, or use Swagger-iu and observe that the parameter from the base class is not reflected in the API

Configuration

# Add your application.properties here, if applicable.

Screenshots
(If applicable, add screenshots to help explain your problem.)

Environment (please complete the following information):

  • Output of uname -a or ver:
    Darwin XXXXX 19.4.0 Darwin Kernel Version 19.4.0: Wed Mar 4 22:28:40 PST 2020; root:xnu-6153.101.6~15/RELEASE_X86_64 x86_64

  • Output of java -version:
    openjdk version "11.0.6" 2020-01-14
    OpenJDK Runtime Environment AdoptOpenJDK (build 11.0.6+10)
    OpenJDK 64-Bit Server VM AdoptOpenJDK (build 11.0.6+10, mixed mode)

  • GraalVM version (if different from Java):

  • Quarkus version or git rev:
    1.3.1.Final

  • Build tool (ie. output of mvnw --version or gradlew --version):
    Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)

Additional context
(Add any other context about the problem here.)

@sean-scott-lr sean-scott-lr added the kind/bug Something isn't working label Apr 6, 2020
@quarkusbot
Copy link

/cc @EricWittmann

@sean-scott-lr
Copy link
Author

Note. I did some digging and found that quarkus uses smallrye to implement OpenAPI. I found this enhancement request in their backlog.
smallrye/smallrye-open-api#239

@geoand
Copy link
Contributor

geoand commented Apr 6, 2020

cc @phillip-kruger

@phillip-kruger
Copy link
Member

Thanks @geoand . @MikeEdgar is working on this. We will let you know once it's fixed.

@geoand
Copy link
Contributor

geoand commented Apr 6, 2020

Excellent, thanks!

@MikeEdgar
Copy link
Contributor

This has been fixed.

@geoand
Copy link
Contributor

geoand commented May 27, 2020

Cool, thanks

@geoand geoand closed this as completed May 27, 2020
@gsmet
Copy link
Member

gsmet commented Jun 2, 2020

@MikeEdgar any idea in which version it has been fixed?

@MikeEdgar
Copy link
Contributor

@gsmet - I believe this was originally fixed in smallrye-open-api 1.2.2.

@gsmet gsmet added this to the 1.4.2.Final milestone Jun 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

7 participants