Defining an enumeration for an array in Swagger 2.0

Question

type": "array", "items": { "type": "string", "enum": ["MALE","FEMALE","WORKER"] } 

or

 type": "array", "items": { "type": "string", }, "enum": ["MALE","FEMALE","WORKER"] 

?

Nothing in the spec about this. The goal is to get swagger-ui to display enum values.

Answer 1

The first case is correct, and nowadays swagger-ui generates a multiple choice of enum values.

Answer 2

This will depend on what you want to list:

Each enumeration value MUST be of a described object type

• in the first case String
• in the second array array row

The first syntax is the possible String values ​​in this array

 AnArray: type: array items: type: string enum: - MALE - FEMALE - WORKER 

This array can contain several rows, but each row must have the value MALE, FEMALE or WORKER.

The second means that these are the possible values ​​of this array

 AnotherArray: type: array items: type: string enum: - - FEMALE - WORKER - - MALE - WORKER 

Each enumeration value is an array. In this example, this array can only have the possible value ["FEMALE", "WORKER"] and ["MALE", "WORKER"].

Unfortunately, even if this syntax is valid, there are no enum values ​​in the Swagger interface.