Read @Assert annotations to determine required fields about nelmioapidocbundle HOT 13 CLOSED

Saying that the column is nullable in the database doesn't mean your API expects a value.

You should use a Form to manage your incoming data. What should be done is a Parser for the validation layer (your Assert annotations), but not for the ORM part.

from nelmioapidocbundle.

Good point. I had not thought of it that way. I've revised the title of this issue to reflect that Assert should be parsed. I presume this would be an enhancement. I'm happy to help on this. Any pointers where I would start to put something like this together?

from nelmioapidocbundle.

+1 for reading @Assert annonation

from nelmioapidocbundle.

I agree with @willdurand .

from nelmioapidocbundle.

👍

from nelmioapidocbundle.

+1

from nelmioapidocbundle.

It's marked as "Easy Pick", dear upvoters, who wants to work on this?

from nelmioapidocbundle.

For output data would be useful.

I have the following attribute:
/**
* Application valoration from 0 to 5
* @Assert\Max(limit = 5)
* @Assert\Min(limit = 0)
* @jms\Type("double")
*/
private $valoration;

At the moment I am writing the max and min in the description, but would be great if this information could be fetched from Assert

from nelmioapidocbundle.

anyone willing to write a PR?

from nelmioapidocbundle.

Looks like it's working now ?

from nelmioapidocbundle.

Confirmed, We use @Assert at entity level, and the docs are pulling that through.

The only problem I can see is that it doesn't support validation groups.

from nelmioapidocbundle.

The Nelmio\ApiDocBundle\Parser\ValidationParser is taking care of the @Assert annotations, but does not consider the groups defined in it.

The problem of not supporting validation groups is that validations that are only part of a specific group, are handled as if they are in the Default group. Excluding them would be a better (not final) solution.

The Nelmio\ApiDocBundle\Parser\JmsMetadataParser consider the @jms\Serializer\Annotation\JMS\Groups annotation.
The Nelmio\ApiDocBundle\Parser\ValidationParser does not consider Symfony asserts groups (@symfony\Component\Validator\Constraints\Assert) nor JMS groups (@jms\Serializer\Annotation\JMS\Groups).

Does anyone knows how to solve it?

from nelmioapidocbundle.

version 3 is a complete rewrite. please check if this is still a problem with version 3 and a recent symfony version.

from nelmioapidocbundle.