Как установить, что значение параметра может быть нулевым в nelmio api doc? - PullRequest
0 голосов
/ 19 февраля 2019

У меня есть API в Symfony Flex, который задокументирован с использованием NelmioApiDocBundle.В документации я хочу показать, что параметр parentPOSId может быть int или null.Как я могу это сделать?

Это мои аннотации контроллера:

 /**
 *
 * @FOSRest\Post("/pos/parent")
 *
 * @SWG\Post(
 *     tags={"pos_parent"},
 *     description="set POS parent",
 *     @SWG\Response(
 *       response=200,
 *       description="Parent was set",
 *       examples={
 *          "application/json":{
 *              "POSId":2,
 *              "parentPOSId": 1
 *          }
 *       }
 *     ),
 *
 *     @SWG\Parameter(
 *         name="form",
 *         in="body",
 *         description="Action parameters",
 *         @Model(type=App\Domain\Port\POSParent\SetPOSParentInterface::class)
 *     )
 * )
 *
 */

Это моя модель:

namespace App\Domain\Port\POSParent;

interface SetPOSParentInterface
{
    public function getPOSId():int;

    public function getParentPOSId():?int;
}
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...