Quarkus: Openapi.yaml file is not consistent to api.json

Created on 23 Jun 2020  路  11Comments  路  Source: quarkusio/quarkus

Describe the bug
We are using desing first for our REST-Api
The openapi.yaml file in swagger-ui, which is rendered with smallrye/openapi i think is not consistent with the api.json used to generate our REST- endpoints.
Vendor-Extensions of Path-Parameters are rendered on the operation not the Parameter.

Expected behavior
Vendor-Extensions of Path-Parameters are rendered on the parameter.

Actual behavior
Vendor-Extensions of Path-Parameters are rendered on the operation.

To Reproduce
It is easy to reproduce this directly in the smallrye codebase (https://github.com/smallrye/smallrye-open-api/issues/376)

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: MINGW64_NT-10.0-18363 XXX 3.0.7-338.x86_64 2019-11-21 23:07 UTC x86_64 Msys
  • Output of java -version: openjdk 11.0.5 2019-10-15 LTS
  • GraalVM version (if different from Java):
  • Quarkus version or git rev: 1.5.2Final
  • Build tool (ie. output of mvnw --version or gradlew --version):

Additional context
I think this is not directly a quarkus bug but it makes quarkus harder to use for us and our project. Perhaps this report can be used as tracking bug for upstream

areopenapi kinbug

All 11 comments

cc @famod

/cc @EricWittmann

/cc @MikeEdgar @phillip-kruger

This is being handled in SmallRye here https://github.com/smallrye/smallrye-open-api/issues/376

Closing here. Fixed in SR

@phillip-kruger Thanks, but we need to update SR in Quarkus so that it is fixed for Quarkus, no?

that should happen via dependabot as soon as we release on the SR side.

@phillip-kruger

as we release on the SR side.

Any idea when this might be the case? Thanks!

Definitely before the next Quarkus release, so that we can get that in. We can also do this earlier if needed.

Next release means 1.7.0 or 1.6.1?

Usually 1.7, except if 1.6.0 introduced a new error, i.e. break something that was working in 1.5.x

Was this page helpful?
0 / 5 - 0 ratings