swagger 3: schema for dictionary of dictionaries

Question

I want to model a schema where response is dictionary of dictionaries:

{
  'id1': {
    'type': 'type1',
    'active': true,
  }, 
  'id2': {
    'type': 'type2',
    'active': false,
  },
  ... 
  ... 
}

I have defined:

components:
  schemas:
    accountData:
      type: object
      required:
        - type
        - active
      properties:
        type:
          type: string
        active:
          type: boolean

    accounts:
      type: object
      additionalProperties:
        type: object
        properties:
          account-id:
            type: object
            $ref: '#/components/schemas/accountData'

Now I want to define '#/components/schemas/accounts' which is a repeating dictionary of '#/components/schemas/account'.

I am very new to OpenApi 3, I am unable to figure out how to do it.

What have you tried? How did that not work? See if this helps: [Swagger HashMap property type](https://stackoverflow.com/q/16042885/113116), [Swagger: map of ](https://stackoverflow.com/q/36136885/113116) — Helen, Feb 05 '18 at 14:53
So you have a `` map. Check out the answers to the linked questions in my previous comment. Those answers are for OpenAPI 2.0, so replace `definitions` with `components.schemas` to adjust for the 3.0 syntax. — Helen, Feb 05 '18 at 15:16
@helen I have updated the question. Can you please check if I am doing it right? — Arindam Choudhury, Feb 05 '18 at 15:58

score 4 · Accepted Answer · answered Feb 05 '18 at 17:07

4

You are almost there. The schema specified in additonalProperties corresponds to the value type in the <key, value> dictionary. In your example, the values are accountData objects, so you should use:

components:
  schemas:
    ...

    accounts:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/accountData'

answered Feb 05 '18 at 17:07

Helen

87,344
17
243
314

1

Where is the in the accounts schema? – Arindam Choudhury Feb 06 '18 at 09:27
3

@ArindamChoudhury: In your example the keys are `'id1'`, `'id2'` etc. In OpenAPI, keys are always strings and are not defined explicitly. – Helen Feb 06 '18 at 10:03
@Helen, may be you know - how can i do this with java annotations? – Dan Brandt Nov 15 '19 at 15:07
1

@DanBrandt I don't know, sorry. Consider [asking a new question](/questions/ask?tags=swagger+java) about Java annotations. – Helen Nov 18 '19 at 08:05

swagger 3: schema for dictionary of dictionaries

1 Answers1

Linked

Related