How to represent a C# Dictionary in OpenAPI?

Question

I have a Web API which returns a object that contains a dictionary property with integer keys:

public Dictionary<int, string> Roles { get; set; }

I use Swashbuckle to publish it into OpenAPI/Swagger format and this is what I get:

"Roles": {
  "type": "object",
  "additionalProperties": {
    "type": "string"
  }
}

I am not really sure this is correct? As there is no indication that my dictionary key is an integer.

How can represent my dictionary correctly in OpenAPI?

score 4 · Accepted Answer · edited May 23 '17 at 11:54

4

It's not supported because in the JSON objects/(dictionaries) the keys have to be strings.

edited May 23 '17 at 11:54

Community

answered Aug 16 '16 at 13:59

Tóth Tibor

1 Answers1