OpenAPI support to register schema for a type from 3rd party lib

[lost22git]

Description

Range class is from 3rd party lib and we can not add openapi schema definition for it.

So we need to add the same definition for every field using Range type.

@Schema(title = "timeRange", implementation = String.class, example = "[2020-02-02T00:00:00Z,2022-02-02T00:00:00Z]")
Range<ZonedDateTime> timeRange

To avoid repeating myself, I would like to know if quarkus openapi provides the functionality to register schema for types of 3rd party libraries？

Implementation ideas

something like:

openapiConfig.registerSchema(
  Schema.of(new GenericType<Range<ZonedDateTime>>() {})
  .implementation(String.class).example("[,]")
  .build()
)

[quarkus-bot]

/cc @EricWittmann (openapi), @MikeEdgar (openapi), @phillip-kruger (openapi)

[MikeEdgar]

Support for this will be available when smallrye-open-api v3.7.0 is released soon, specifically from smallrye/smallrye-open-api#1609.

You would use configuration rather than an API/builder. Escapes and new-lines added for readability.

mp.openapi.schema.com.example.Range<java.time.ZonedDateTime>={ \
  "name": "ZonedDateTimeRange", \
  "type": "string", \
  "title": "timeRange", \
  "example": "[2020-02-02T00:00:00Z,2022-02-02T00:00:00Z]" \
}