partkeepr

commit 1ed21872f7c8f87e1c3da18d456287dad5142979
parent 09f0385b97805d566e2f035921cdaff076f72f0e
Author: Felicitus <felicitus@felicitus.org>
Date:   Mon,  8 Jun 2015 22:16:11 +0200

Added proper API documentation to the Unit Controller

Diffstat:
M
src/PartKeepr/UnitBundle/Controller/DefaultController.php
 | 
12
++++++------

1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/PartKeepr/UnitBundle/Controller/DefaultController.php b/src/PartKeepr/UnitBundle/Controller/DefaultController.php
@@ -19,7 +19,7 @@ class DefaultController extends DoctrineRESTQueryController
      *
      * @Routing\Route("/unit", defaults={"method" = "get","_format" = "json"})
      * @Routing\Method({"GET"})
-     * @ApiDoc(output="array<PartKeepr\UnitBundle\Entity\Unit>")
+     * @ApiDoc(section="unit",output="array<PartKeepr\UnitBundle\Entity\Unit>")
      *
      * @View()
      *
@@ -35,7 +35,7 @@ class DefaultController extends DoctrineRESTQueryController
      *
      * @Routing\Route("/unit/{id}", defaults={"method" = "get","_format" = "json"})
      * @Routing\Method({"GET"})
-     * @ApiDoc()
+     * @ApiDoc(section="unit",output="PartKeepr\UnitBundle\Entity\Unit")
      * @View()
      */
     public function getAction ($id) {
@@ -47,7 +47,7 @@ class DefaultController extends DoctrineRESTQueryController
      *
      * @Routing\Route("/unit/{id}", defaults={"_format" = "json"})
      * @Routing\Method({"PUT"})
-     * @ApiDoc()
+     * @ApiDoc(section="unit",input="PartKeepr\UnitBundle\Entity\Unit",output="PartKeepr\UnitBundle\Entity\Unit")
      *
      * @View()
      */
@@ -57,11 +57,11 @@ class DefaultController extends DoctrineRESTQueryController
     }
 
     /**
-     * Saves a single unit
+     * Creates a single unit
      *
      * @Routing\Route("/unit", defaults={"_format" = "json"})
      * @Routing\Method({"POST"})
-     * @ApiDoc()
+     * @ApiDoc(section="unit",input="PartKeepr\UnitBundle\Entity\Unit",output="PartKeepr\UnitBundle\Entity\Unit")
      *
      * @View()
      */
@@ -75,7 +75,7 @@ class DefaultController extends DoctrineRESTQueryController
      *
      * @Routing\Route("/unit/{id}", defaults={"_format" = "json"})
      * @Routing\Method({"DELETE"})
-     * @ApiDoc()
+     * @ApiDoc(section="unit")
      *
      * @View()
      */