Laravel array validation in swagger

Question

My form-data consists of an array 'items' which contains details like:

items[0][id]:1
items[0][amount]:50
items[1][id]:2
items[1][amount]:25

This is how it looks like in postman. How can I write the swagger comments for this structure? Below is the comment I've built but it doesn't work.

 /**
 *  @QA\Property(
 *      property="items[]", 
 *      type="array",
 *      @QA\Items(
 *          type="object",
 *          @QA\Property(property="id", type="string"),
 *          @QA\Property(property="amount", type="string"),
 *      ),
 *  ),
 */
 public $items;

Let me know what needs to be done to solve this issue.

Helen · Accepted Answer · 2022-01-20 16:00:44Z

1

OpenAPI Specification currently does not support this kind of serialization for nested objects and arrays of objects in form data. In other words, there is no syntax to define this data format.

There's a corresponding enhancement request:
https://github.com/OAI/OpenAPI-Specification/issues/1706
It discusses query parameters, but if implemented it will extend to form data too (because form data uses the same serialization methods as query parameters).

A possible workaround is to change the API to accept application/json instead of form data and send this body as a JSON array of objects.

"items: [
  {
    "id": 1,
    "amount": 50
  },
  {
    "id": 2,
    "amount": 25
  }
]

answered Jan 20, 2022 at 16:00

Helen

99.8k18 gold badges280 silver badges352 bronze badges

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

1 Comment

Devender Gupta Over a year ago

But actually, my form-data consists of files too. That's why I'm not using application/json, to be honest. And yea, I did find this as the solution in their issues list. I went through all of them and found it was already reported here. Thanks, for replying though.

Collectives™ on Stack Overflow

Laravel array validation in swagger

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related