Skip to content

updated swagger descriptions#148

Open
korzhevmd24 wants to merge 6 commits intomainfrom
misha_renaming_swagger
Open

updated swagger descriptions#148
korzhevmd24 wants to merge 6 commits intomainfrom
misha_renaming_swagger

Conversation

@korzhevmd24
Copy link
Copy Markdown

@korzhevmd24 korzhevmd24 commented Apr 5, 2026

Были добавлены описания для всех эндпоинтов в сваггере

Они включают в себя:

  • условия на использование
  • скоупы
  • возможные параметры
  • что возвращают
  • возможные ошибки

@korzhevmd24 korzhevmd24 force-pushed the misha_renaming_swagger branch from c46ad6f to 19e49cc Compare April 20, 2026 06:16
@github-actions
Copy link
Copy Markdown

💩 Code linting failed, use black and isort to fix it.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

Summary

Tests Skipped Failures Errors Time
131 0 💤 0 ❌ 0 🔥 16.841s ⏱️

@github-actions
Copy link
Copy Markdown

💩 Code linting failed, use black and isort to fix it.

@github-actions
Copy link
Copy Markdown

💩 Code linting failed, use black and isort to fix it.

@github-actions
Copy link
Copy Markdown

💩 Code linting failed, use black and isort to fix it.

Copy link
Copy Markdown
Member

@petrCher petrCher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Наверху над моими комментами в коде написано comment on line . Обрати внимание если там не одна строка а несколько, чтобы не упустить ничего. Также я откомментил только один файл, в остальных почти все хорошо кроме аналогичных проблем с тем файлом, что я откомментил. Так что менять надо все файлы

- список объектов `Event`

Returns a list of events.
Ошибки:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ахаххаха, забавно)
попробуй как минимум ввести -100

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ошибки отсутствуют лучше не писать никогда))

Comment on lines +34 to +35
Ошибки:
- отсутствуют
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

аналогично
плюс пробуй ввести туда например текст

Comment on lines +22 to +23
Условия:
- Пользователь должен быть аутентифицирован
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

убрать
ты же ниже про скупы написал, что доступно любому авторизованному пользователю

Comment on lines +66 to +67
Ошибки:
- `ObjectNotFound` — тип предмета с указанным `type_id` не найден
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

вот, в комментах выше что-то такое тоже надо делать

Comment on lines +60 to +61
Параметры:
- `item` — данные нового предмета
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

это неправда, там параметры type_id и is_available

Comment on lines +95 to +98
Условия:
- Пользователь должен быть аутентифицирован
- Пользователь должен иметь право на изменение предметов
- Предмет с указанным `id` должен существовать
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

аналогично убрать

Comment on lines +145 to +146
- Пользователь должен быть аутентифицирован
- Пользователь должен иметь право на удаление предметов
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

только это убрать, про статусы оставить, там правильно

- удаляется сам предмет
- удаляются связанные сессии аренды (если они не помечены как удалённые)
- удаляются связанные страйки и события
- действие логируется как `DELETE_ITEM`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

логируется в event, из контекста это неочевидно

Обновляет статус доступности предмета по его идентификатору.

Эндпоинт позволяет изменить только поле `is_available`.
После успешного обновления действие логируется как `UPDATE_ITEM`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

логируется в event, из контекста это неочевидно

Comment on lines +192 to +196
Условия:
- отсутствуют (доступно без авторизации)

Скоупы:
- отсутствуют
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

условия и скоупы удалить, зачем про них писать если не требуется?

@petrCher
Copy link
Copy Markdown
Member

Также сейчас падает один из тестов (linting). надо сделать форматирование black isort перед отправкой. Делается по команде make format(см мейкфайл)

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 this pull request may close these issues.

переделать документацию ко всем ручкам

2 participants