Scheme example with random values like “zzz”

[kauanmocelin]

I’m using the SmallRye OpenAPI extension with Quarkus v3.20.1. When the OpenAPI JSON document is generated, Swagger displays random example values for string fields, such as "zzz" or "ddd", which change every time the page is refreshed.

Why is this happening? How can I disable it and make Swagger always show just "string" as the example?

[MikeEdgar]

Hi @kauanmocelin do you have a reproducer? Can you confirm it's happening in the OpenAPI YAML/JSON also, and not only in Swagger UI?

[kauanmocelin]

@MikeEdgar I checked the openapi.json and the result is:

"PesquisaDocumentoRequest":{
   "type":"object",
   "required":[
      "termo"
   ],
   "properties":{
      "termo":{
         "type":"string",
         "minLength":3,
         "maxLength":100,
         "pattern":"\\S"
      }
   }
},

This behavior occurs for the termo property. I'm using quarkus-rest and quarkus-smallrye-openapi dependecies, and I haven't changed any Swagger configurations.

Could this behavior be expected because I set a minLenght? Actually, I want to disable this behaviour and just keep the value type as string for the fields, is there a way to achieve that?

[MikeEdgar]

@kauanmocelin you will probably need to set your own example value in the schema to avoid having Swagger UI generate one. If you're already using the @Schema annotation, you can add it there.

class PesquisaDocumentoRequest {
    @Schema(minLength = 3, maxLength = 100, pattern = "\\\\S", example = "Example of termo")
    String termo;
}