API improvements (#1826)

src/Form/AbstractRateForm.php

@@ -27,7 +27,7 @@ abstract class AbstractRateForm extends AbstractType
                 // documentation is for NelmioApiDocBundle
                 'documentation' => [
                     'type' => 'number',
-                    'description' => 'Rate',
+                    'description' => 'The rate (eg. 10.5)',
                 ],
                 'label' => 'label.rate',
                 'attr' => [
@@ -40,7 +40,7 @@ abstract class AbstractRateForm extends AbstractType
                 // documentation is for NelmioApiDocBundle
                 'documentation' => [
                     'type' => 'number',
-                    'description' => 'Internal rate',
+                    'description' => 'The internal rate (eg. 10.0 or 10)',
                 ],
                 'label' => 'label.rate_internal',
                 'currency' => $currency,
@@ -50,6 +50,10 @@ abstract class AbstractRateForm extends AbstractType
             ->add('isFixed', YesNoType::class, [
                 'label' => 'label.fixedRate',
                 'help' => 'help.fixedRate',
+                'documentation' => [
+                    'type' => 'boolean',
+                    'description' => 'If "true" each time record gets the same rate, regardless of its duration',
+                ],
             ])
         ;
     }

src/Form/TagEditForm.php

@@ -29,6 +29,10 @@ class TagEditForm extends AbstractType
                 'attr' => [
                     'autofocus' => 'autofocus'
                 ],
+                'documentation' => [
+                    'type' => 'string',
+                    'description' => 'The tag name (forbidden character: comma)',
+                ],
             ])
             ->add('color', ColorPickerType::class);
     }

src/Form/TeamEditForm.php

@@ -32,7 +32,7 @@ class TeamEditForm extends AbstractType
                 // documentation is for NelmioApiDocBundle
                 'documentation' => [
                     'type' => 'string',
-                    'description' => 'Name of the new team',
+                    'description' => 'Name of the team',
                 ],
             ])
             ->add('teamlead', UserType::class, [
@@ -49,6 +49,12 @@ class TeamEditForm extends AbstractType
                 'multiple' => true,
                 'expanded' => $options['expand_users'],
                 'by_reference' => false,
+                'documentation' => [
+                    'type' => 'array',
+                    'items' => ['type' => 'integer', 'description' => 'User IDs'],
+                    'title' => 'Team member',
+                    'description' => 'Array of team member IDs',
+                ],
             ])
         ;
     }

src/Form/Type/ColorPickerType.php

@@ -33,6 +33,10 @@ class ColorPickerType extends AbstractType implements DataTransformerInterface
     public function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setDefaults([
+            'documentation' => [
+                'type' => 'string',
+                'description' => sprintf('The color code as hex (default: %s)', self::DEFAULT_COLOR),
+            ],
             'label' => 'label.color',
         ]);
     }

src/Form/Type/UserType.php

@@ -34,6 +34,10 @@ class UserType extends AbstractType
                 return $user->getDisplayName();
             },
             'choice_translation_domain' => false,
+            'documentation' => [
+                'type' => 'integer',
+                'description' => 'User ID',
+            ],
         ]);
 
         $resolver->setDefault('query_builder', function (Options $options) {

src/Form/UserCreateType.php

@@ -56,6 +56,7 @@ class UserCreateType extends UserEditType
         parent::configureOptions($resolver);
 
         $resolver->setDefaults([
+            'validation_groups' => ['UserCreate'],
             'include_add_more' => false,
         ]);
     }

src/Form/UserEditType.php

@@ -72,6 +72,7 @@ class UserEditType extends AbstractType
     public function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setDefaults([
+            'validation_groups' => ['Profile'],
             'data_class' => User::class,
             'csrf_protection' => true,
             'csrf_field_name' => '_token',

src/Form/UserPasswordType.php

@@ -41,6 +41,7 @@ class UserPasswordType extends AbstractType
     public function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setDefaults([
+            'validation_groups' => ['PasswordUpdate'],
             'data_class' => User::class,
             'csrf_protection' => true,
             'csrf_field_name' => '_token',

src/Form/UserRolesType.php

@@ -40,6 +40,7 @@ class UserRolesType extends AbstractType
     public function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setDefaults([
+            'validation_groups' => ['RolesUpdate'],
             'data_class' => User::class,
             'csrf_protection' => true,
             'csrf_field_name' => '_token',