Forum Discussion

lia's avatar
lia
New Contributor
2 years ago

Dictionaries mapping strings to Array?

Hello, you all. I aim to generate the spec through a NestJS project, and It's all working until now. The problem arises when I want to specify that return data is a Dict that maps a key to an array o...
Swagger Core
Swagger Editor
  • ponelat's avatar
    ponelat
    2 years ago

    Hi lia ,

     

    You were very close, there isn't a "isArray" flag but there is an "array" type. See the following example...

    components:
  schemas:
    CustomMap:
      type: object
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/CustomObjectType'      
    CustomObjectType:
      type: object

     See: https://swagger.io/docs/specification/data-models/data-types/#array

ponelat's avatar
ponelat
Staff
2 years ago

Hi lia ,

 

You were very close, there isn't a "isArray" flag but there is an "array" type. See the following example...

components:
  schemas:
    CustomMap:
      type: object
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/CustomObjectType'      
    CustomObjectType:
      type: object

 See: https://swagger.io/docs/specification/data-models/data-types/#array

  • lia's avatar
    lia
    New Contributor
    2 years ago

    Thank you, ponelat, it totally solved my problem, it was exactly that. I thought that maybe an Array type would fit, but I had no idea how to specify the item's type. It seems very clear now. ðŸ˜¸