Swagger PHP annotation for object of array

Question

I want to include Array of objects in api/doc view. But I am unable to get that.

From the code below:

@SWG\Schema(        
  @SWG\Property(property="project-name", type="string"),    
  @SWG\Property(property="project-detail", type="array",
    @SWG\Items(type="object",
        @SWG\Property(property="name", type="string", ),
        @SWG\Property(property="category", type="string",),
    ),
    @SWG\Items(type="object",
        @SWG\Property(property="new_name", type="string", ),
        @SWG\Property(property="new_category", type="string",),
    ),
  ),
),

I get the output:

{
  "project-name": "string",
  "project-detail": [
     {
       "name": "string",
       "category": "string"
     }
   ]
}

But I want below one:

{
  "project-name": "string",
  "project-detail": [
     {
       "name": "string",
       "category": "string"
     },
     {
       "new_name": "string",
       "new_category": "string"
     },
   ]
}

Please help me out for this.

Swagger 2 does not support compound types (Type1|Type2), this was only added to OpenApi 3 (see swagger.io/docs/specification/data-models/oneof-anyof-allof-not/…). Unfortunately to use it you have to upgrade to NelmioApiDocBundle v4 (see github.com/nelmio/NelmioApiDocBundle/blob/master/…). — Guilhem N
– Guilhem N, Commented Aug 15, 2020 at 15:56
Put it in example in project detail level property ex. example="{{}, {}, {}, {}}" — RNEL
– RNEL, Commented Oct 13, 2021 at 15:03

Lorddistrict · Accepted Answer · 2020-02-07 13:42:43Z

2

You can only display one object on the array of objects. Because Swagger has been created to explain what you have to give to the API and what is returned (not required).

When you're looking an array and an object inside, of course you're understanding this isn't an array with 1 object.

Hope it helps !

Lord'

answered Feb 7, 2020 at 13:42

Lorddistrict

512 bronze badges

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

Comments

RNEL · Accepted Answer · 2021-10-13 15:09:22Z

0

Modify your project detail property by adding example ex.

example="{
         {
          "name": "String",
          "category": "String"
         }, 
         {
          "name": "String",
          "category": "String"
         }
        }"

answered Oct 13, 2021 at 15:09

RNEL

911 gold badge2 silver badges10 bronze badges

Collectives™ on Stack Overflow

Swagger PHP annotation for object of array

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related