Array of objects as an input parameter in swagger

Question

I'm trying to describe the following post parameter in swagger:

{
    "sources": [
        {
            "id": 101,
            "parentId": 201
        },{
            "id": 102,
            "parentId": 201
        },{
            "id": 102,
            "parentId": 202
        }
    ],
    "destinationId": 301,
    "param1": "value 1",
    "param2": "value 2",
}

The issue is that the sources is an array of objects, that swagger does not seem to support. Here is what I tried:

paths:
    /bulk-action:
        post:
            parameters:
                - name: sources
                  in: formData
                  type: array
                  enum:
                      $ref: '#/definitions/BulkSource'
                - name: destinationId
                  in: formData
                  type: integer
                - name: param1
                  in: formData
                  type: string
                - name: param2
                  in: formData
                  type: string
definitions:
    BulkSource:
        type: object
        properties:
            id:
                type: integer
            parentId:
                type: integer

Any idea on how to work around this limitation?

Wilson · Accepted Answer · 2016-09-25 11:28:13Z

17

If I understand correctly, your request body to post is a json object instead of form. In such case, your swagger document need to be modified as follows:

When request body is json, a parameter with in: body is used instead of multiple parameters of in: formData.
If in is body, a schema object is required.
Defined the json properties under schema. If the property type is array, items object is required.

Following is an example:

paths:
  /bulk-action:
    post:
      consumes:
        - application/json
      parameters:
        - name: body
          in: body
          schema:
            properties:
              sources:
                type: array
                items:
                  $ref: '#/definitions/BulkSource'
              destinationdId:
                type: integer
      responses:
        200:
          description: OK
definitions:
  BulkSource:
    type: object
    properties:
      id:
        type: integer
      parentId:
        type: integer

edited Sep 25, 2016 at 11:28

answered Sep 25, 2016 at 11:22

Wilson

11.7k2 gold badges32 silver badges33 bronze badges

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

6 Comments

Kunal Pal Over a year ago

could you please tell me where you are making these changes. Or what I want to ask is, in which file the above code is written. I am unable to find the above code in my swagger API.

Rishi Over a year ago

What if my request body' array does not have the title or name similar to 'Sources' present in the OP body???? I have similar problem, only my request body does not have the name of array. It is more similar to [ { key: value, key: value }, { key: value, key: value } ]

esh Over a year ago

@Rishikesh have you figured out how to do that?

Rishi Over a year ago

@esh Yes, I figured it for OpenApi 3.0.1, you just have to ignore the title or name and continue with the type field. For 2.0, I still haven't got any solution...

JSking Over a year ago

@Wilson can you assist me with this. am trying to collect form array in swaggerPHP, dont know how to define it so swagger can render it well,

|

Collectives™ on Stack Overflow

Array of objects as an input parameter in swagger

1 Answer 1

6 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

6 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related