Swagger PHP - Describe array of objects

Question

I use Laravel + Swagger PHP. In one of my services, I handle parameters like this :

$params = [
    'addressChild' => [
        'address' => ' ... ',
        'city' => ' ... ',
    ],
    'addressParent' => [
        'address' => ' ... ',
        'city' => ' ... ',
    ],
];

I am trying to describe this schema in Swagger Annotations, using OpenApi 3 :

/**
 * @OA\Post(
 *      path="/entity/{entity}/addresses",
 *      @OA\Response(
 *          response=200,
 *          @OA\JsonContent()
 *      ),
 *      @OA\RequestBody(
 *          description="Addresses to store",
 *          required=true,
 *          @OA\JsonContent(
 *              type="object",
 *              @OA\Property()
 *          ),
 *      ),
 * )
 *
 */
public function update(Request $request)
{
    // ...
}

I tried many things like :

 @OA\JsonContent(
     type="object",
     @OA\Property(name="addressKid", ref="#/components/schemas/ParkingAddressRequest") // error
 ),

My address data is described in ref="#/components/schemas/ParkingAddressRequest" schema, how can I set it as an array in RequestBody ?

AymDev · Accepted Answer · 2022-01-31 17:30:40Z

4

If I understood your problem, you could do it like this

/**
 * @OA\Post(
 *      path="/entity/{entity}/addresses",
 *      @OA\Response(
 *          response=200,
 *          @OA\JsonContent()
 *      ),
 *      @OA\RequestBody(
 *          description="Addresses to store",
 *          required=true,
 *          @OA\JsonContent(
 *              type="array",
 *              @OA\Items(ref="#/components/schemas/ParkingAddressRequest")
 *          ),
 *      ),
 * )
 *
 */

edited Jan 31, 2022 at 17:30

AymDev

7,7234 gold badges34 silver badges59 bronze badges

answered Oct 15, 2020 at 21:36

Patric Robert Gutersohn

5111 gold badge5 silver badges11 bronze badges

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

Collectives™ on Stack Overflow

Swagger PHP - Describe array of objects

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related