How to define a nested array with a swagger query?

Question

My method is POST, but it gets data by query parameters. I can't change the logic of the method to retrieve data by body. Is it possible to send a nested array in a query (not in http body, as it usually done in post queries) in this way:

@SWG\Parameter(
    name="find_data",
    in="query",
    type="array",
     required=true,
        SWG\Items(
            SWG\Property(property="service", type="integer", description="Client"),
            SWG\Property(property="tariff", type="integer", description="tariff"),
            SWG\Property(property="connection", type="integer", description="Connection")
        )
)?

I have done the following:

@SWG\Post(path="/tariff/get-by-data",
     tags={"Tariffs"},
     operationId="actionGetByData",
     summary="Find tariffs",
     @SWG\Parameter(
         name="type",
         in="query",
         type="string",
         required=true,
         description="Type of connect",
     ),
     @SWG\Parameter(
         name="find_data[0][service]",
         in="query",
         type="string",
         required=true,
         description="Client",
     ),
     @SWG\Parameter(
         name="find_data[0][tariff]",
         in="query",
         type="string",
         required=true,
         description="Tariff",
     ),
     @SWG\Parameter(
         name="find_data[0][connection]",
         in="query",
         type="string",
         required=true,
         description="Connection",
     ),
     @SWG\Response(
         response = 200,
         description = "Success",
         @SWG\Schema(
            @SWG\Property(property="id", type="integer", description="Id tariff")
         )
     )
)

but in swagger it doesn't look very nice, especially when trying to query in ui.

Also I tried make like here. I changed in="body" on in="query", but it gave out an error Failed to load API definition. Fetch errorInternal Server Error /api/docs/json-schema

OpenAPI Specification does not support arrays of objects in the query string. — Helen
– Helen, Commented Apr 12, 2023 at 16:32
I voted up for @Helen answer. You need to use OpenApi 3 instead of 2. — SiZE
– SiZE, Commented Apr 14, 2023 at 8:16

ChantOfSpirit · Accepted Answer · 2024-08-08 12:21:07Z

0

Found similar sample that you asking, can be helpful:

@OA\Parameter(
     name="body",
     in="query",
     required=false,
     explode=true,
     @OA\Schema(
          collectionFormat="multi",
          required={"product_id"},
          @OA\Property(property="product_id",  type="string",  ),
          @OA\Property(
                property="products",
                type="array",
                @OA\Items(
                      type="object",
                      format="query",
                      @OA\Property(property="name", type="string", ),
                      @OA\Property(property="category", type="string",),
                ),
           ),
     ),
)

So, the answer is:

@SWG\Parameter( -> @SWG\Schema( -> @SWG\Items( and you can add additional @SWG\items( if needed

answered Aug 8, 2024 at 12:21

ChantOfSpirit

1561 gold badge1 silver badge10 bronze badges

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

Collectives™ on Stack Overflow

How to define a nested array with a swagger query?

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