Is it possible to define an enum parameter with swagger-php? about swagger-php HOT 12 CLOSED

/**
 * @SWG\Parameter(
 *   name="status",
 *   in="query",
 *   type="string",
 *   enum={"pending", "failed", "completed"}
 * )
 */

Documented here and used in the petstore example here

from swagger-php.

@pakcybershagufta and everyone else:

 *   @OA\Parameter(
 *     @OA\Schema(
 *       default="value1",
 *       type="string",
 *       enum={
 *         "value1",
 *         "value2",
 *       },
 *     ),
 *     description="Value Values.",
 *     example="value1",
 *     in="query",
 *     name="values",
 *     required=true,
 *   ),

Creates a Select with Options, where one value must be chosen, value1 is selected by default.

from swagger-php.

Currently you can with the following example:

@property string<'Two Pigs','Duck', 'And 1 Cow'> $enumVal This is an enum value.

With the coming changes (Doctrine Annotations) it will look like:

    /**
     *
     *
     * @var string
     *
     * @Property(
     *      type="string",
     *      @allowableValues(
     *          valueType="LIST",
     *          values="['available', 'pending', 'sold']"
     *      ),
     *      description="pet status in the store")
     */
    protected $status;

And the parameter definition in the doctrine annotations looks like:

     *        @parameter(
     *           name="status",
     *           description="Status values that need to be considered for filter",
     *           paramType="query",
     *           defaultValue="available",
     *           @allowableValues(valueType="LIST", values="['available', 'pending', 'sold']"),
     *           required="true",
     *           allowMultiple=true,
     *           dataType="string"
     *         )

from swagger-php.

Thanks for you response. So currently I figure it's only possible to define it in a model but not as query parameter? Is that correct?

I noticed the Doctrine annotations branch, looks very nice! What's the schedule for it to merge it into the master branch?

from swagger-php.

I am hoping to be able to merge it this weekend, it is passing tests now; however I want to get a caching layer in place and perhaps a bit of refactoring if there is time and more importantly documentation of the annotations. SHA: c8b536c046fa3e0fe050a6fc5c9ce871d1be7242 I just pushed and it appears to be fully functional so far more tests would be great.

from swagger-php.

Awesome that's soon! Yeah, documentation is important I think. At the moment I find myself sometimes looking at the unit tests to see what the correct notation or options are :)

from swagger-php.

0.4.0 addresses this and is documented in further detail at http://zircote.com/swagger-php

from swagger-php.

Where this is documented? I can't find on docs.

from swagger-php.

Thanks!

from swagger-php.

/**
 * @SWG\Parameter(
 *   name="status",
 *   in="query",
 *   type="string",
 *   enum={"pending", "failed", "completed"}
 * )
 */

Documented here and used in the petstore example here

Thank you ..great job

from swagger-php.

How set default value in enum and please tell me also how set multi select also like colors colors select multiple colors

from swagger-php.

HOw we use anyOf etc preperty exact format please?

from swagger-php.