Quarkus Scala 3 and Swagger
#43812
Replies: 2 comments 4 replies
-
|
/cc @MikeEdgar (swagger-ui), @phillip-kruger (swagger-ui) |
Beta Was this translation helpful? Give feedback.
0 replies
-
|
@lmlynik you can override the scanned schema for these types using configuration. For example: |
Beta Was this translation helpful? Give feedback.
4 replies
-
|
Thanks @MikeEdgar for fast response. I've tried mp.openapi.schema.scala.Option={ "type": "string", "nullable": true }and with this the application can't start Also from the provided sample it seems we fix that all Options are Strings, which isn't true, as its a generic type. IS there a way to make this generically apply just the underlying value? |
Beta Was this translation helpful? Give feedback.
-
Yes, you can provide a generic type argument to the property name. It's not clear to be what the issue is that caused that stack trace, unfortunately. |
Beta Was this translation helpful? Give feedback.
-
|
@MikeEdgar is there a possibilty to wire on some interface which would entrirely override how these sample jsons are being generated? |
Beta Was this translation helpful? Give feedback.
-
|
@lmlynik there isn't at the moment. We have handling for Kotlin types in smallrye-open-api [1], so we can probably add Scala types as well if you can open an issue and provide a list of types you are aware of that are commonly used that are part of Scala. |
Beta Was this translation helpful? Give feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Question for Quarkus Community:
I'm using https://github.com/carlosedp/scala3-quarkus-quickstart with Quarkus and Scala, and I ran into an issue with how Swagger generates sample data for my Scala case classes.
Here's an excerpt of my code:
I’ve added DefaultScalaModule to Jackson to handle serialization and deserialization for the Scala case classes and enums. Serialization works as expected, but Swagger (OpenAPI) is generating incorrect examples in the UI for Option and enum types:
{ "userId": 0, "activityType": {}, "timestamp": "2022-03-10T12:15:50", "value": { "empty": true, "defined": true } }Ideally, I'd like:
The Option type to be represented as null or omitted (not as an object with empty and defined fields).
The enum (ActivityType) to be represented as a simple string in the Swagger UI, instead of an empty object.
I believe it might be an issue with how Swagger interprets Scala-specific types. Does anyone have suggestions on configuring Jackson or Swagger in Quarkus to fix this, or is the only option to manually craft jsons for OpenAPI to render?
Thanks!
Beta Was this translation helpful? Give feedback.
All reactions