Метод Swagger, чтобы показать требования атрибутов

Я новичок в Swagger и пытаюсь понять, как определить, какие атрибуты модели требуются, а какие нет, которые не следует отправлять для каждого действия.

Например, при регистрации пользовательских атрибутов first_name,last_name,email а также password являются обязательными. Однако это не требуется при обновлении других атрибутов. Кроме того, некоторые атрибуты никогда не должны отправляться, такие как role,

В настоящее время у меня есть это:

/**
* @SWG\Post(
*   path="/user/register",
*   summary="Registers a new user",
*   consumes={"application/json"},
*   required={"first_name","last_name"},
*   @SWG\Parameter(
*     name="User",
*     description="User attributes",
*     in="body",
*     required=true,
*     type="string",
*     @SWG\Schema(ref="#/definitions/User")
*   ),
*   @SWG\Response(
*     response=200,
*     description="User object",
*     @SWG\Schema(
*       @SWG\Items(ref="#definitions/User")
*     )
*   )
* )
*/

Я хотел бы добавить что-то вроде:

required={"first_name","last_name","email","password"},
ignore={"role","registration_date","status"},

Это возможно?

2

Решение

Задача ещё не решена.

Другие решения

Других решений пока нет …

По вопросам рекламы [email protected]