Update Swagger definition in order to be compatible with string ident…

…ifiers (#634)
sonata-project · Sep 1, 2020 · 3822ff4 · 3822ff4
1 parent 058c6fd
commit 3822ff4
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 22 deletions.
diff --git a/src/Controller/Api/CommentController.php b/src/Controller/Api/CommentController.php
@@ -44,7 +44,7 @@ public function __construct(CommentManagerInterface $commentManager)
      * @ApiDoc(
      *  resource=true,
      *  requirements={
-     *      {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Comment identifier"}
+     *      {"name"="id", "dataType"="string", "description"="Comment identifier"}
      *  },
      *  output={"class"="Sonata\NewsBundle\Model\Comment", "groups"={"sonata_api_read"}},
      *  statusCodes={
@@ -55,7 +55,7 @@ public function __construct(CommentManagerInterface $commentManager)
      *
      * @REST\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
      *
-     * @param int $id Comment identifier
+     * @param string $id Comment identifier
      *
      * @throws NotFoundHttpException
      *
@@ -71,7 +71,7 @@ public function getCommentAction($id)
      *
      * @ApiDoc(
      *  requirements={
-     *      {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Comment identifier"}
+     *      {"name"="id", "dataType"="string", "description"="Comment identifier"}
      *  },
      *  statusCodes={
      *      200="Returned when comment is successfully deleted",
@@ -80,7 +80,7 @@ public function getCommentAction($id)
      *  }
      * )
      *
-     * @param int $id Comment identifier
+     * @param string $id Comment identifier
      *
      * @throws NotFoundHttpException
      *
@@ -102,7 +102,7 @@ public function deleteCommentAction($id)
     /**
      * Returns a comment entity instance.
      *
-     * @param int $id Comment identifier
+     * @param string $id Comment identifier
      *
      * @throws NotFoundHttpException
      *

diff --git a/src/Controller/Api/PostController.php b/src/Controller/Api/PostController.php
@@ -106,7 +106,7 @@ public function getPostsAction(ParamFetcherInterface $paramFetcher)
      *
      * @ApiDoc(
      *  requirements={
-     *      {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Post identifier"}
+     *      {"name"="id", "dataType"="string", "description"="Post identifier"}
      *  },
      *  output={"class"="sonata_news_api_form_post", "groups"={"sonata_api_read"}},
      *  statusCodes={
@@ -117,7 +117,7 @@ public function getPostsAction(ParamFetcherInterface $paramFetcher)
      *
      * @REST\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
      *
-     * @param int $id A post identifier
+     * @param string $id Post identifier
      *
      * @return Post
      */
@@ -154,7 +154,7 @@ public function postPostAction(Request $request)
      *
      * @ApiDoc(
      *  requirements={
-     *      {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Post identifier"}
+     *      {"name"="id", "dataType"="string", "description"="Post identifier"}
      *  },
      *  input={"class"="sonata_news_api_form_post", "name"="", "groups"={"sonata_api_write"}},
      *  output={"class"="sonata_news_api_form_post", "groups"={"sonata_api_read"}},
@@ -165,7 +165,7 @@ public function postPostAction(Request $request)
      *  }
      * )
      *
-     * @param int     $id      Post identifier
+     * @param string  $id      Post identifier
      * @param Request $request Symfony request
      *
      * @throws NotFoundHttpException
@@ -182,7 +182,7 @@ public function putPostAction($id, Request $request)
      *
      * @ApiDoc(
      *  requirements={
-     *      {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Post identifier"}
+     *      {"name"="id", "dataType"="string", "description"="Post identifier"}
      *  },
      *  statusCodes={
      *      200="Returned when post is successfully deleted",
@@ -191,7 +191,7 @@ public function putPostAction($id, Request $request)
      *  }
      * )
      *
-     * @param int $id Post identifier
+     * @param string $id Post identifier
      *
      * @throws NotFoundHttpException
      *
@@ -215,7 +215,7 @@ public function deletePostAction($id)
      *
      * @ApiDoc(
      *  requirements={
-     *      {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Post identifier"}
+     *      {"name"="id", "dataType"="string", "description"="Post identifier"}
      *  },
      *  output={"class"="Sonata\DatagridBundle\Pager\PagerInterface", "groups"={"sonata_api_read"}},
      *  statusCodes={
@@ -229,7 +229,7 @@ public function deletePostAction($id)
      *
      * @REST\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
      *
-     * @param int $id Post identifier
+     * @param string $id Post identifier
      *
      * @return PagerInterface
      */
@@ -254,7 +254,7 @@ public function getPostCommentsAction($id, ParamFetcherInterface $paramFetcher)
      *
      * @ApiDoc(
      *  requirements={
-     *      {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Post identifier"}
+     *      {"name"="id", "dataType"="string", "description"="Post identifier"}
      *  },
      *  input={"class"="sonata_news_api_form_comment", "name"="", "groups"={"sonata_api_write"}},
      *  output={"class"="Sonata\NewsBundle\Model\Comment", "groups"={"sonata_api_read"}},
@@ -268,7 +268,7 @@ public function getPostCommentsAction($id, ParamFetcherInterface $paramFetcher)
      *
      * @REST\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
      *
-     * @param int $id Post identifier
+     * @param string $id Post identifier
      *
      * @throws HttpException
      *
@@ -310,8 +310,8 @@ public function postPostCommentsAction($id, Request $request)
      *
      * @ApiDoc(
      *  requirements={
-     *      {"name"="postId", "dataType"="integer", "requirement"="\d+", "description"="Post identifier"},
-     *      {"name"="commentId", "dataType"="integer", "requirement"="\d+", "description"="Comment identifier"}
+     *      {"name"="postId", "dataType"="string", "description"="Post identifier"},
+     *      {"name"="commentId", "dataType"="string", "description"="Comment identifier"}
      *  },
      *  input={"class"="sonata_news_api_form_comment", "name"="", "groups"={"sonata_api_write"}},
      *  output={"class"="Sonata\NewsBundle\Model\Comment", "groups"={"sonata_api_read"}},
@@ -324,8 +324,8 @@ public function postPostCommentsAction($id, Request $request)
      *
      * @REST\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
      *
-     * @param int     $postId    Post identifier
-     * @param int     $commentId Comment identifier
+     * @param string  $postId    Post identifier
+     * @param string  $commentId Comment identifier
      * @param Request $request   Symfony request
      *
      * @throws NotFoundHttpException
@@ -399,7 +399,7 @@ protected function filterCriteria(ParamFetcherInterface $paramFetcher)
     /**
      * Retrieves post with id $id or throws an exception if it doesn't exist.
      *
-     * @param int $id Post identifier
+     * @param string $id Post identifier
      *
      * @throws NotFoundHttpException
      *
@@ -419,8 +419,8 @@ protected function getPost($id)
     /**
      * Write a post, this method is used by both POST and PUT action methods.
      *
-     * @param Request  $request Symfony request
-     * @param int|null $id      Post identifier
+     * @param Request     $request Symfony request
+     * @param string|null $id      Post identifier
      *
      * @return View|FormInterface
      */