l5-swagger/swagger-php - adding component to block makes it dissapear from the output

Question

If I add this response to my definition:

@OA\Response(
    response="default",
    description="unexpected error",
    @OA\JsonContent(ref="#/components/schemas/ErrorModel"),
    @OA\XmlContent(ref="#/components/schemas/ErrorModel"),
    @OA\MediaType(
        mediaType="text/xml",
        @OA\Schema(ref="#/components/schemas/ErrorModel")
        ),
        @OA\MediaType(
          mediaType="text/html",
          @OA\Schema(ref="#/components/schemas/ErrorModel")
        )
 )

And then I place the Schema underneath like so:

/**
 * @OA\Schema(
 *     schema="ErrorModel",
 *     required={"code", "message"},
 *     @OA\Property(
 *         property="code",
 *         type="integer",
 *         format="int32"
 *     ),
 *     @OA\Property(
 *         property="message",
 *         type="string"
 *     )
 * )
 */

The command: php artisan l5-swagger:generate does not error but the block that contains the Response Definition with the component no longer gets included in the json but the schema for the component does?

Did I do something really obvious that is wrong as my experience with the library so far is if you do something wrong it generally tells you.

DerManoMann · Accepted Answer · 2022-02-27 03:34:46Z

3

If this is a new projects changes are that you are now using swagger-php V4. In version 4 the analyser code uses reflection. This was done to make it possible to use either annotations or PHP 8 attributes.

One downside is that stand-alone docblocks are no longer detected as there is no reflection to access those.

In your case I think having two separate blocks of /** */ will mean only the last one is found.

One way around is to have all annotations preceding a class in a single /** */ block. Another option is to have (unused) dummy classes for cases like this.

Here, adding class ErrorModel {} fater your schema should work too, assuming there is a separate resonse class for the first annotation.

The same applies to other top level annotations like @OA\Info or others.

answered Feb 27, 2022 at 3:34

DerManoMann

5392 silver badges4 bronze badges

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

1 Comment

UrbanwarfareStudios Over a year ago

@DemManoMann - thank you simply moving them into the same /** */ block fixed the problem of the entire block going missing.

Daniel Candido · Accepted Answer · 2022-07-19 12:19:07Z

1

The annotations cannot be separate, should be in the same block

example:

change this:

/** 
 * @OA\Info( 
 *      version="1.0.0", 
 *      title="Service",
 *      description="Service",
 *      @OA\Contact(
 *          email="[email protected]"
 *      ),
 *     @OA\License(
 *         name="Name"
 *     ),
 * ),
 */

/**
 * @OA\Schema(
 *     schema="ErrorModel",
 *     required={"code", "message"},
 *     @OA\Property(
 *         property="code",
 *         type="integer",
 *         format="int32"
 *     ),
 *     @OA\Property(
 *         property="message",
 *         type="string"
 *     )
 * )
 */

for this:

/**
 * @OA\Info(
 *      version="1.0.0",
 *      title="Service",
 *      description="Service",
 *      @OA\Contact(
 *          email="[email protected]"
 *      ),
 *     @OA\License(
 *         name="Name"
 *     ),
 * ),
 *
 * @OA\Schema(
 *     schema="ErrorModel",
 *     required={"code", "message"},
 *     @OA\Property(
 *         property="code",
 *         type="integer",
 *         format="int32"
 *     ),
 *     @OA\Property(
 *         property="message",
 *         type="string"
 *     )
 * )
 */

edited Jul 19, 2022 at 12:19

answered Jul 19, 2022 at 12:18

Daniel Candido

212 bronze badges

1 Comment

Nisal Gunawardana Over a year ago

This fixed my issue.

Collectives™ on Stack Overflow

l5-swagger/swagger-php - adding component to block makes it dissapear from the output

2 Answers 2

1 Comment

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related