Create Swagger descriptions for volunteer api #185
Conversation
| @ApiCreatedResponse({ type: Promise<Task[]> }) | ||
| @ApiUnauthorizedResponse({ description: 'Требуется авторизация' }) | ||
| @ApiForbiddenResponse({ description: 'Требуется другой статус или роль' }) | ||
| @ApiBadRequestResponse({ description: 'Произошла ошибка' }) |
There was a problem hiding this comment.
А точно просто "ошибка"? Или есть конкретный косяк в запросе?
| @ApiCreatedResponse({ type: Promise<Task> }) | ||
| @ApiUnauthorizedResponse({ description: 'Требуется авторизация' }) | ||
| @ApiForbiddenResponse({ description: 'Требуется другой статус или роль' }) | ||
| @ApiBadRequestResponse({ description: 'Произошла ошибка' }) |
| @ApiOperation({ summary: 'Получение новых задач по статусу' }) | ||
| @ApiQuery({ type: GetTasksSearchDto }) | ||
| @ApiCreatedResponse({ type: Promise<Task[]> }) | ||
| @ApiUnauthorizedResponse({ description: 'Требуется авторизация' }) |
There was a problem hiding this comment.
Нужно не только сделать описание, но и показать пример ответа, т.е. при ошибке у нас выбросится объект вида...
There was a problem hiding this comment.
Рома, надо нормально описать ошибку 400.
Например, на ручке PUT /recipient/tasks/:id/accept ошибка 400 возникнет, если :id не пройдёт валидацию, на ручке GET /volunteer/tasks/accepted' - если не отвалидируется search query (описанное GetTasksSearchDto`).
Именно это и надо указать в описании ошибки в Swagger.
| } | ||
| }) | ||
| @ApiBadRequestResponse({ | ||
| description: 'Ошибка запроса. В нём есть пользователь?', |
There was a problem hiding this comment.
Нет, надо внятно объяснить в чём проблема. В каких случаях летит 400? Проанализируй код контроллера и dto, и распиши, какие возможны ошибки.
| } | ||
| }) | ||
| @ApiBadRequestResponse({ | ||
| description: 'Ошибка запроса. В нём есть пользователь?', |
| } | ||
| } | ||
| }) | ||
| @ApiBadRequestResponse({ |
| } | ||
| }) | ||
| @ApiBadRequestResponse({ | ||
| description: 'Ошибка запроса. В нём есть пользователь?', |
| } | ||
| }) | ||
| @ApiBadRequestResponse({ | ||
| description: 'Ошибка запроса. В нём есть пользователь?', |
No description provided.