how can specify format for parameters?

[ghanbari]

I use input property of @ApiDoc annotation for specifieng of parameters of my api that are form's fields.

* @ApiDoc(
 *      section="User",
 *      resource=true,
 *      input={
 *          "class"="Nik\UserBundle\Form\UserType",
 *      },
 *     ....

data_class of form is a entity that have constraint validation for properties.

I expect that nelmio api doc specify parameter format as validation constraints of entity, but format are empty.

stack overflow

How can i specify parameter formats in nelmio ApiDocBundle?

[BenjaminPaap]

With #739 this is now possible. Just override your form parameters with another parameter definition like this:

/**
 * @ApiDoc(
 *     input = {
 *         "class" = "AppBundle\Form\UserForm"
 *     },
 *     parameters = {
 *         { "name" = "firstname", "dataType" = "string", "format" = "My special format" }
 *     }
 * )
 */

[ghanbari]

@BenjaminPaap @willdurand
what is benefit of use of input class?, if i force define all parameters manually?

[BenjaminPaap]

When using an input class your parameters instantly change when you change the underlying form class.

[ghanbari]

@BenjaminPaap
yes, it is usefull, but i must always either redefine parameters in @Apidoc or write a another document for UI developer that specify formats for fields.

[ghanbari]

@willdurand @BenjaminPaap

please see this answer, why validationParser can detect format from FormType properties, but can not guess they from validation annotations that define on entity properties?

sry, i can not speak english good