Model response containing array of different object types in swagger

Question

I want to model a response object containing an array of different types of objects in swagger, something like this:

{
   "table": [
        {
          "user" : []
        },
        {
          "customer": []
        },
        {
           "employee": []
        }
    ]
}

I have tried a solution below but it wraps all the properties in a single object { [ { "user": [], "customer": [] } ] }.

  responses:
    200:
      schema:
        type: array
        items:
          type: object
          properties:
            user:
              type: array
              items:
                $ref: '#/definitions/User'
            customer:
              type: array
              items:
                $ref: '#/definitions/Customer'
            employee:
              type: array
              items:
                $ref: '#/definitions/Employee'

This question has solutions for OpenAPI/Swagger 2.0.

Helen
– Helen

2017-06-28 13:24:51 +00:00
Commented Jun 28, 2017 at 13:24 — Helen
– Helen, Commented Jun 28, 2017 at 13:24

William Cheng · Accepted Answer · 2016-12-14 04:20:25Z

4

That will be supported in the next release of OpenAPI spec (3.0) and here is the related discussion about this feature:

https://github.com/OAI/OpenAPI-Specification/issues/57

Here is an example (provided in the URL above):

{
  "oneOf": [
    { "$ref": "Cat" },
    { "$ref": "Dog" }
  ]
}

answered Dec 14, 2016 at 4:20

William Cheng

11k5 gold badges57 silver badges85 bronze badges

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

Collectives™ on Stack Overflow

Model response containing array of different object types in swagger

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related