Forum Discussion

BostonKevin's avatar
BostonKevin
Contributor
6 years ago

Can You Define a Response Consisting of an Array With Two Different Objects?

Hi!   It is easy to define a response that consists of an array made up of several objects.  Is it possible to define a response consisting of two separate objects?   When I have attempted to...
  • HKosova's avatar
    HKosova
    6 years ago
    BostonKevin wrote:

    Data is packed into two distinct objects that are in the same array.

    That's exactly how the first example with oneOf works.

     

     

    "type": "array",
    "items": {
      "oneOf": [
        { "$ref": "#/components/schemas/Schema1" },
        { "$ref": "#/components/schemas/Schema2" }
      ]
    }

    means that the array contains Schema1 and/or Schema2.

  • HKosova's avatar
    HKosova
    6 years ago

    Correct.

BostonKevin's avatar
BostonKevin
Contributor

Just to be clear, the oneOf directive does NOT work like an exclusive OR (EOR).  It specifies that any member of an array can have the structure defined in either Schema1 or Schema2, correct? 

HKosova's avatar
HKosova
SmartBear Alumni (Retired)
6 years ago

Correct.

  • BostonKevin's avatar
    BostonKevin
    Contributor
    6 years ago

    That is a very useful feature.

  • swaggerUser's avatar
    swaggerUser
    New Member
    5 years ago

    Hi All,

     

    I have a similar issue where I need to define an array with two separate objects in swagger 2.0. Do you have any suggestions on how to implement this in 2.0 ?