Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Volonteer Api. Описание ручек в Swagger #168

Open
4 tasks done
INextYP opened this issue Sep 7, 2024 · 0 comments · May be fixed by #185
Open
4 tasks done

Volonteer Api. Описание ручек в Swagger #168

INextYP opened this issue Sep 7, 2024 · 0 comments · May be fixed by #185
Assignees

Comments

@INextYP
Copy link
Collaborator

INextYP commented Sep 7, 2024

Branch: feat/swagger-volunteer-api

В рамках задачи необходимо описать все ручки в Volonteer Api с использованием декораторов из @nestjs/swagger.

Документирование должно получиться максимально подробным.

  • описание ручки (кратко и на русском языке)
  • описание body, query, param (если таковые имеются) с типами данных, которые ожидаются
  • описание ответа (если есть)
  • описания всех вариаций ошибок (пройдитесь по методам, гардам и посмотрите, что может выплюнуть ручка)

Все дополнительные описания ручек можете предлагать в чате в Пачке - утвердим

@zoomkolol zoomkolol self-assigned this Sep 13, 2024
@zoomkolol zoomkolol linked a pull request Sep 15, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants