OpenApi for php doesn't render enum values correctly

Question

I am building some documentation using OpenApi and Swagger, but I am unable to test it because of a js error.

I want to define a parameter that will accept specific values so I added enum in the schema attribute. I am defining the orderBy parameter in a GET request like this

*     @OA\Parameter(in="query", name="orderBy", required=false, allowEmptyValue=true, description="Sort type of results", examples={"asc", "desc"}, schema={"type": "string", "enum": {"asc", "desc"}, "default": "asc"})

When the documentation is generated I am getting the error below

Developer tools

GeorgeKaf · Accepted Answer · 2021-01-27 13:36:16Z

4

Removed examples attribute and it rendered properly.

*     @OA\Parameter(in="query", name="orderBy", required=false, allowEmptyValue=true, description="Sort type of results", examples={"asc", "desc"}, schema={"type": "string", "enum": {"asc", "desc"}, "default": "asc"})

answered Jan 27, 2021 at 13:36

GeorgeKaf

6231 gold badge10 silver badges24 bronze badges

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

Collectives™ on Stack Overflow

OpenApi for php doesn't render enum values correctly

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