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

2

You should use additionalProperties (Ref: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#model-with-mapdictionary-properties)

Here is an example:

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

where Tweets has a property name

answered Mar 2, 2016 at 10:36

William Cheng

10.9k5 gold badges57 silver badges85 bronze badges

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

1 Comment

Eric H. Over a year ago

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....

Collectives™ on Stack Overflow

Object array with keys in swagger

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related