Object array with keys in swagger

Question

We got an existing webservice that we attempt to document using Swagger. It often seems to return objects using:

schema: type: array items: $ref: '#/definitions/Tweets'

In this model the id of the tweet is in the Tweets definition. My returned output is formatted like this:

{ "127":{ "name":"Foo" }, "110":{ "name":"Bar" } }

Where the id is the key of the object. How do i do this is in Swagger?

William Cheng · Accepted Answer · 2016-03-02 10:36:05Z

Here is an example:

type: object additionalProperties: $ref: '#/definitions/Tweets'

where Tweets has a property name

Just for clarification, the additionalProperties attribute basically means, there are additional properties in this object, not defined in properties and they have the defined schema....

1 Answer 1