Forum Discussion

BostonKevin's avatar
BostonKevin
Contributor
5 years ago
Solved

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
    5 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
    5 years ago

    Correct.

BostonKevin's avatar
BostonKevin
Contributor

Hi!

 

Thanks for your help but the problem is that it is not that the response can be one or the other.  Data is packed into two distinct objects that are in the same array. For the sack of clarity, I am referring to Schema1 and Schema2.

 

It might be best to return two different arrays with one array containing the Schema1 objects and the other array containing the Schema2 objects.  I will investigate.

 

Best,

Kevin

HKosova's avatar
HKosova
SmartBear Alumni (Retired)
5 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.

  • BostonKevin's avatar
    BostonKevin
    Contributor
    5 years ago

    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)
      5 years ago

      Correct.

      • BostonKevin's avatar
        BostonKevin
        Contributor
        5 years ago

        That is a very useful feature.