API improvements (#1826)

src/Entity/Team.php

@@ -12,6 +12,8 @@ namespace App\Entity;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use JMS\Serializer\Annotation as Serializer;
+use Swagger\Annotations as SWG;
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 use Symfony\Component\Validator\Constraints as Assert;
 
@@ -23,48 +25,92 @@ use Symfony\Component\Validator\Constraints as Assert;
  * )
  * @ORM\Entity(repositoryClass="App\Repository\TeamRepository")
  * @UniqueEntity("name")
+ *
+ * @Serializer\ExclusionPolicy("all")
  */
 class Team
 {
     /**
+     * The internal ID
+     *
      * @var int
      *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Default"})
+     *
      * @ORM\Column(name="id", type="integer")
      * @ORM\Id
      * @ORM\GeneratedValue(strategy="IDENTITY")
      */
     private $id;
     /**
+     * Team name
+     *
      * @var string
      *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Default"})
+     *
      * @ORM\Column(name="name", type="string", length=100, nullable=false)
      * @Assert\NotBlank()
      * @Assert\Length(min=2, max=100, allowEmptyString=false)
      */
     private $name;
     /**
+     * Teamlead
+     *
+     * The teamlead for this team
+     *
      * @var User
      *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Team_Entity"})
+     * @SWG\Property(ref="#/definitions/User")
+     *
      * @ORM\ManyToOne(targetEntity="App\Entity\User")
      * @ORM\JoinColumn(onDelete="CASCADE", nullable=false)
      * @Assert\NotNull()
      */
     private $teamlead;
     /**
+     * Team member
+     *
+     * All team member, including the teamlead
+     *
      * @var User[]|ArrayCollection
      *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Team_Entity"})
+     * @SWG\Property(type="array", @SWG\Items(ref="#/definitions/User"))
+     *
      * @ORM\ManyToMany(targetEntity="User", mappedBy="teams", fetch="EXTRA_LAZY")
      */
     private $users;
     /**
+     * Customers
+     *
+     * All customers assigned to the team
+     *
      * @var Customer[]|ArrayCollection
      *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Team_Entity"})
+     * @SWG\Property(type="array", @SWG\Items(ref="#/definitions/Customer"))
+     *
      * @ORM\ManyToMany(targetEntity="Customer", mappedBy="teams", fetch="EXTRA_LAZY")
      */
     private $customers;
     /**
+     * Projects
+     *
+     * All projects assigned to the team
+     *
      * @var Project[]|ArrayCollection
      *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Team_Entity", "Expanded"})
+     * @SWG\Property(type="array", @SWG\Items(ref="#/definitions/Project"))
+     *
      * @ORM\ManyToMany(targetEntity="Project", mappedBy="teams", fetch="EXTRA_LAZY")
      */
     private $projects;