Swagger for PHP array of arrays

Question

I am trying to create a response example that should return an array like this:

[
  [
    "Shop Name",
    "53.7094190",
    "-1.9084720"
    ,1
  ]
]

For this I am using this code:

*   @OA\Response(
*     response= "default",
*     description="Success: Array of shops",
*     @OA\MediaType(
*       mediaType="text/plain",
*         @OA\Schema(
*           type = "array",
*           @OA\Items( type="array",
*              @OA\Items(type="string", default="'Bridge Balti','53.7094190','-1.9084720',1"),
*           ),
*         )
*     )
*   )

And I am getting this in swagger hub:

[
  [
    "string"
  ]
]

Alexey Bril · Accepted Answer · 2018-12-21 11:23:30Z

1

If you just want to display an example in swagger ui, then you need to use the "example" parameter.

@OA\Items(type="string",example="'Bridge Balti','53.7094190','-1.9084720',1")

answered Dec 21, 2018 at 11:23

Alexey Bril

5631 gold badge8 silver badges24 bronze badges

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

1 Comment

Jacobski Over a year ago

I'm trying this solution but somehow it ends as a single item for me: "test": [ "'Bridge Balti','53.7094190','-1.9084720',1" ] Any chance I might be doing it differently?

Bala · Accepted Answer · 2024-01-06 07:21:14Z

0

Accepted answer doen't work for me. Instead of array, it was showing as string. Following change works for me. ( Double quotes does the magic )

example="[""Bridge Balti"",""53.7094190"",""-1.9084720"",1]"

answered Jan 6, 2024 at 7:21

Bala

9839 silver badges18 bronze badges

Collectives™ on Stack Overflow

Swagger for PHP array of arrays

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related