use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
-use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
-use Wallabag\CoreBundle\Entity\Entry;
+use Symfony\Component\HttpFoundation\Request;
use Wallabag\AnnotationBundle\Entity\Annotation;
+use Wallabag\CoreBundle\Entity\Entry;
class AnnotationRestController extends WallabagRestController
{
* }
* )
*
- * @param Entry $entry
- *
* @return JsonResponse
*/
public function getAnnotationsAction(Entry $entry)
* @ApiDoc(
* requirements={
* {"name"="ranges", "dataType"="array", "requirement"="\w+", "description"="The range array for the annotation"},
- * {"name"="quote", "dataType"="string", "required"=false, "description"="Optional, quote for the annotation"},
- * {"name"="text", "dataType"="string", "required"=true, "description"=""},
+ * {"name"="quote", "dataType"="string", "description"="The annotated text"},
+ * {"name"="text", "dataType"="string", "required"=true, "description"="Content of annotation"},
* }
* )
*
- * @param Request $request
- * @param Entry $entry
- *
* @return JsonResponse
*/
public function postAnnotationAction(Request $request, Entry $entry)
*
* @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
*
- * @param Annotation $annotation
- * @param Request $request
- *
* @return JsonResponse
*/
public function putAnnotationAction(Annotation $annotation, Request $request)
*
* @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
*
- * @param Annotation $annotation
- *
* @return JsonResponse
*/
public function deleteAnnotationAction(Annotation $annotation)