Describe the feature Currently, the <code class="no

`OpenApiExample` doesn't support lists about javalin-openapi HOT 2 CLOSED

dennisameling commented on June 14, 2024 1

`OpenApiExample` doesn't support lists

from javalin-openapi.

Comments (2)

dzikoysk commented on June 14, 2024 3

You can use a new annotation called @OpenApiExampleProperty to define more complex examples. For instance, this setup:

@OpenApiExample(objects = {
    @OpenApiExampleProperty(value = "2022-08-14T21:13:03.546Z"),
    @OpenApiExampleProperty(value = "2022-08-14T21:13:03.546Z")
})
public @NotNull String[] getTimestamps() {
    return new String[] { timestamp };
}

@OpenApiExample(objects = {
        @OpenApiExampleProperty(name = "Barbie", objects = {
                @OpenApiExampleProperty(name = "name", value = "Margot Robbie"),
                @OpenApiExampleProperty(name = "link", value = "https://www.youtube.com/watch?v=dQw4w9WgXcQ")
        }),
})
public @NotNull Object[] getExampleObjects() {
    return new String[] { timestamp };
}

should be generated as:

"timestamps" : {
  "type" : "array",
  "items" : {
    "type" : "string"
  },
  "example" : [ "2022-08-14T21:13:03.546Z", "2022-08-14T21:13:03.546Z" ]
},
"exampleObjects" : {
  "type" : "array",
  "items" : {
    "type" : "object"
  },
  "example" : {
    "Barbie" : {
      "name" : "Margot Robbie",
      "link" : "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  }
},