Specifying multiple types for the same field in OpenAPI specs

Question

I am looking to represent the following JSON Object in OpenAPI:

 {
   "name": "filter name",
   "type": "type of filter",
   "depends_on": "parent filter",

    // the value can be :
   "values": ["value 1", "value 2", ...]   

   // or
   "value": {
      "parent 1" : ["value 1", "value 2", ...],
      "parent 2": [ "value 3", "value 4", ...],
      ..... 
    }
 }

I have tried to use the following spec

Filters:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        depends_on:
          type: string
        values:
          type: object
          additionalProperties:
            oneOf:
              - integer
              - string

but it didn't work as expected.

Can anyone help me with this

Please clarify your specific problem or provide additional details to highlight exactly what you need. As it's currently written, it's hard to tell exactly what you're asking. — Community
– Community Bot, Commented Dec 20, 2021 at 21:07

Oussama ROUABAH · Accepted Answer · 2021-12-14 11:26:59Z

2

Solved using oneOf: I found the solution here

    Filters:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        depends_on:
          type: string
        values:
          oneOf:
            - type: object
              properties:
                parent value:
                  type: array
                  items:
                    type: string
                    example: "value 1"
            - type: array
              items:
                type: string

answered Dec 14, 2021 at 11:26

Oussama ROUABAH

411 silver badge7 bronze badges

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

Collectives™ on Stack Overflow

Specifying multiple types for the same field in OpenAPI specs

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related