Добавить сваггер для эндпойнтов дружбы #100
Assignees
Comments
birthdaysgift
added a commit
that referenced
this issue
Nov 21, 2023
В рамках работы над задачами добавления сваггера для профиля (#95), дружбы (#100) и желания (#104), мы предполагали, что файл будет иметь строковый тип и будет представлен ссылкой, поэтому в код сваггера мы добавили его в таком виде: ```python "avatar": "/files/0b928aaa-521f-47ec-8be5-396650e2a187" ``` И схемы для сваггера выглядели соответствующим образом: ```python class Avatar(str): """Avatar value field.""" class Profile(Schema): ... # something here avatar: Avatar | None ... # something here ``` Также исходя из этого предположения, во время работы над задачей реализации эндпойнта регистрации (#88) была добавлена колонка `avatar` в модель `Profile` с типом строка: ```python avatar: Mapped[str | None] = mapped_column(String, unique=True) ``` Но после того, как мы начали работать над задачей добавления сваггера для эндпойнтов файла (#108), мы поняли, что вместо строкового типа нам надо использовать uuid в качестве идентификатора файла. Из этого следует, что нам необходимо внести следующие изменения в уже существующий код, описаный выше: - Заменить `avatar` (string) на `avatar_id` (uuid) в существующих схемах и примерах сваггера - Заменить `avatar` (string) на `avatar_id` (uuid) в существующей модели базы данных (`Profile`) В рамках этой задачи необходимо внести изменения, описанные выше. --- **Примечания** Внесения подобных изменений можно было бы избежать, если бы схема для работы с файлами была продумана и добавлена в репозиторий заранее. Т.е. сваггер для эндпойнтов файлов, необходимо было добавить ещё до того, как будет добавлен хоть какой-то сваггер для эндпойнтов приложения, т.к. эндпойнты приложения используют файлы, и необходимо знать заранее как мы планируем работать с файлами. Но поскольку это не было сделано вовремя, то сейчас необходимо внести правки в уже существующий функционал, а так же добавить сваггер для эндпойнтов файла (#108) и реализацию для них этих эндпойнтов, до того как будет добавлен какой-либо новый функционал приложения.
birthdaysgift
added a commit
that referenced
this issue
Nov 24, 2023
В рамках работы над задачами добавления сваггера для профиля (#95), дружбы (#100) и желания (#104), мы предполагали, что файл будет иметь строковый тип и будет представлен ссылкой, поэтому в код сваггера мы добавили его в таком виде: ```python "avatar": "/files/0b928aaa-521f-47ec-8be5-396650e2a187" ``` И схемы для сваггера выглядели соответствующим образом: ```python class Avatar(str): """Avatar value field.""" class Profile(Schema): ... # something here avatar: Avatar | None ... # something here ``` Также исходя из этого предположения, во время работы над задачей реализации эндпойнта регистрации (#88) была добавлена колонка `avatar` в модель `Profile` с типом строка: ```python avatar: Mapped[str | None] = mapped_column(String, unique=True) ``` Но после того, как мы начали работать над задачей добавления сваггера для эндпойнтов файла (#108), мы поняли, что вместо строкового типа нам надо использовать uuid в качестве идентификатора файла. Из этого следует, что нам необходимо внести следующие изменения в уже существующий код, описаный выше: - Заменить `avatar` (string) на `avatar_id` (uuid) в существующих схемах и примерах сваггера - Заменить `avatar` (string) на `avatar_id` (uuid) в существующей модели базы данных (`Profile`) В рамках этой задачи необходимо внести изменения, описанные выше. --- **Примечания** Внесения подобных изменений можно было бы избежать, если бы схема для работы с файлами была продумана и добавлена в репозиторий заранее. Т.е. сваггер для эндпойнтов файлов, необходимо было добавить ещё до того, как будет добавлен хоть какой-то сваггер для эндпойнтов приложения, т.к. эндпойнты приложения используют файлы, и необходимо знать заранее как мы планируем работать с файлами. Но поскольку это не было сделано вовремя, то сейчас необходимо внести правки в уже существующий функционал, а так же добавить сваггер для эндпойнтов файла (#108) и реализацию для них этих эндпойнтов, до того как будет добавлен какой-либо новый функционал приложения.
birthdaysgift
added a commit
that referenced
this issue
Nov 24, 2023
В рамках работы над задачами добавления сваггера для профиля (#95), дружбы (#100) и желания (#104), мы предполагали, что файл будет иметь строковый тип и будет представлен ссылкой, поэтому в код сваггера мы добавили его в таком виде: ```python "avatar": "/files/0b928aaa-521f-47ec-8be5-396650e2a187" ``` И схемы для сваггера выглядели соответствующим образом: ```python # src/profile/fields.py: class Avatar(str): """Avatar value field.""" # src/profile/schemas.py: class Profile(Schema): ... # something here avatar: Avatar | None ... # something here ``` Также исходя из этого предположения, во время работы над задачей реализации эндпойнта регистрации (#88) была добавлена колонка `avatar` в модель `Profile` с типом строка: ```python avatar: Mapped[str | None] = mapped_column(String, unique=True) ``` Но после того, как мы начали работать над задачей добавления сваггера для эндпойнтов файла (#108), мы поняли, что вместо строкового типа нам надо использовать uuid в качестве идентификатора файла. Из этого следует, что нам необходимо внести следующие изменения в уже существующий код, описаный выше: - Заменить `avatar` (string) на `avatar_id` (uuid) в существующих схемах и примерах сваггера - Заменить `avatar` (string) на `avatar_id` (uuid) в существующей модели базы данных (`Profile`) В рамках этой задачи необходимо внести изменения, описанные выше. --- **Примечания** Внесения подобных изменений можно было бы избежать, если бы схема для работы с файлами была продумана и добавлена в репозиторий заранее. Т.е. сваггер для эндпойнтов файлов, необходимо было добавить ещё до того, как будет добавлен хоть какой-то сваггер для эндпойнтов приложения, т.к. эндпойнты приложения используют файлы, и необходимо знать заранее как мы планируем работать с файлами. Но поскольку это не было сделано вовремя, то сейчас необходимо внести правки в уже существующий функционал, а так же добавить сваггер для эндпойнтов файла (#108) и реализацию для них этих эндпойнтов, до того как будет добавлен какой-либо новый функционал приложения.
birthdaysgift
added a commit
that referenced
this issue
Jan 25, 2024
Во время работы над добавлением сваггера для эндпойнтов дружбы (#100), мы забыли прописать входные параметры для роута reject_friendship_request: ```python async def reject_friendship_request() -> None: # ^^ тут ``` В рамках этой задачи необходимо добавить пропущенные параметры запроса - `request_id` и `access_token`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
После того как была разработана архитектура эндпойнтов аторизации (#77) и профиля (#95), можно приступить к разработке архитектуры эндпойнтов для работы с друзьями пользователя.
В рамках этой задачи необходимо разработать архитектуру эндпойнтов Дружбы и добавить определения сваггера.
The text was updated successfully, but these errors were encountered: