How do I tell swagger that parameter dataType is an array of objects?

Question

I am annotating action method with @ApiImplicitParams

new ApiImplicitParam(
    dataType = "Array[Model]", // <- What should I write here?
    paramType = "body",
    name = "body",
    required = true,
    allowMultiple = false,
    value = "The JSON array of messages to be logged.")

[LModel does not work as well.

Luca T. · Accepted Answer · 2018-01-09 10:42:32Z

4

You should be able to use dataTypeClass field, instead of dataType.

new ApiImplicitParam(
  dataTypeClass = classOf[Array[Model]],
  paramType = "body",
  name = "body",
  required = true,
  value = "The JSON array of messages to be logged.")

answered Jan 9, 2018 at 10:42

Luca T.

1,6511 gold badge14 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Pavel Voronin Over a year ago

looks like this property does not exist in swagger.core 1.5.8 which is referenced by swagger-play 1.5.3

Luca T. Over a year ago

yes, it seems to be added in swagger-core 1.5.13, that should be available in swagger-play 1.6.0 (only for play-2.6.x and above)

Aboodz Over a year ago

swagger-play 1.6.0 is based on swagger-core 1.5.12, so it this property is not available too

Collectives™ on Stack Overflow

How do I tell swagger that parameter dataType is an array of objects?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related