JaxrsOpenApiContextBuilder adds deprecated = true to most OpenAPI operations

[David Hoffer]

We are using swagger's JaxrsOpenApiContextBuilder (dependency below) to generate the OpenAPI docs in a Quarkus application.

<dependency> <groupId>io.swagger.core.v3</groupId> <artifactId>swagger-jaxrs2</artifactId> <version>2.1.11</version> </dependency>

However when Quarkus moved from version 2.3.0.Final to 2.3.1.Final it caused a transitive dependency change on hibernate-core (dependency below) from 5.6.0.Beta2 to 5.6.0.Final.

<dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-core</artifactId> </dependency>

Note later versions of Quarkus/Hibernate/Swagger do not fix this.

The change to 5.6.0.Final is what is causing Swagger to add the deprecated = true on almost all operations. What could be the cause of this? Is this a bug in hibernate or Swagger?  I'm hoping someone has some clues on this and can point me in the right direction.

-Dave

[Phillip Krüger]

Hi Dave.

I do not know the answer to you question, but just out of interest, did you try and use smallrye-openapi extension to generate your OpenAPI ? Is there any reason you want to use swagger-jaxrs2 ?

[David Hoffer]

Its just because of a legacy implementation that came from Thorntail days.  If we were to start over we would look at the smallrye-openapi extension.  One question I have on that, how can I access the final OpenAPI structure that it generates and modify it?  We have some requirements that might not be included in the implementation, such as ordering schemas alphabetically and other modifictions.

-Dave

[Phillip Kruger]

That should be possible if you use smallrye-openapi. There are a few options to do that.

You can use filters to add certain things to the schema. (see https://download.eclipse.org/microprofile/microprofile-open-api-1.0/microprofile-openapi-spec.html#_oasfilter)

You can supply your own (subset) of the schema that will be merged into the final one. (see https://quarkus.io/guides/openapi-swaggerui#loading-openapi-schema-from-static-files)

There might also be a configuration that already enable what you want to do (see https://quarkus.io/guides/openapi-swaggerui#configuration-reference)

There are a lot of benefits to moving to smallrye-openapi, for example auto security, auto tagging and customized swagger-ui.

At some point we are planning to add support for swagger annotation (see https://github.com/smallrye/smallrye-open-api/issues/752) but it's not being worked on at the moment

Cheers

--
You received this message because you are subscribed to the Google Groups "Quarkus Development mailing list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to quarkus-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/quarkus-dev/6a4fa248-1322-47b0-9205-181f5256a520n%40googlegroups.com.

[David Hoffer]

Sounds good.  At some point I would like to try switching to use smallrye-openapi.