Forum Discussion

libertyandco's avatar
libertyandco
New Contributor
7 years ago

How to documente this array

Hi,    I'm writing my API documentation to swagger.io and I have a problem. I don't know how to documente my array in yaml.   My array (it's JSON) :   { "quiz_id": "10", "api_ukey": "KY...
RonRatovsky's avatar
RonRatovsky
Icon for Staff rankStaff
7 years ago

Hello,

 

The OpenAPI specification does not allow you to add constaints to arbitrarily defined keys. To describe 'answers' you can go with:

 

  answers:
    type: object
    additionalProperties:
      type: array
      items:
        type: integer

The definition about says that 'answers' is an object that can have any key, and the value of that key must be an array of integers.