hrbox-public/api
5
0
Fork 0
Code Issues Pull Requests 6 Actions Packages Projects Releases Wiki Activity

H-2626: admin shop API v2 в swagger #43

Open
anton wants to merge 3 commits from feature/H-2626 into master
pull from: feature/H-2626
merge into: :master
Conversation 7 Commits 3 Files Changed 1
+965
anton commented 2026-07-21 17:40:51 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

Summary

  • Добавлены 28 admin/shop эндпоинтов в v2/swagger.yaml: product / product-option / order / delivery-address + категории товаров.
  • Новые теги, схемы AdminShop* и общий HttpJsonResult.

Links

📋 Code Review Summary

Changes Overview

  • Проверен Swagger-контракт всех admin Shop API v2 endpoints и сопоставлен с backend MR !8064.

Risk Assessment 🟡

  • Значения manager/user cancellation в описании order_status_id не соответствуют backend enum.

Verdict

Требуется исправление документации перед merge.

Issues: 🟡 1

✅ Review fixes — 14.08.2026

Значения CANCELED_MANAGER и CANCELED_USER синхронизированы с backend enum во всех добавленных описаниях.

Resolved: 🟡 1

## Summary - Добавлены 28 admin/shop эндпоинтов в `v2/swagger.yaml`: product / product-option / order / delivery-address + категории товаров. - Новые теги, схемы `AdminShop*` и общий `HttpJsonResult`. ## Links - YouTrack: https://youtrack.hrenot.com/issue/H-2626 - HRBox MR: https://git.hrenot.com/hrbox/hrbox/-/merge_requests/8064 --- ## 📋 Code Review Summary ### Changes Overview - Проверен Swagger-контракт всех admin Shop API v2 endpoints и сопоставлен с backend MR !8064. ### Risk Assessment 🟡 - Значения manager/user cancellation в описании `order_status_id` не соответствуют backend enum. ### Verdict Требуется исправление документации перед merge. **Issues: 🟡 1** --- ## ✅ Review fixes — 14.08.2026 Значения `CANCELED_MANAGER` и `CANCELED_USER` синхронизированы с backend enum во всех добавленных описаниях. **Resolved: 🟡 1**
anton commented 2026-07-21 17:45:18 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

added 1 commit

  • 9820f972 - H-2626: admin shop API v2 в swagger

Compare with previous version

added 1 commit <ul><li>9820f972 - H-2626: admin shop API v2 в swagger</li></ul> [Compare with previous version](/hrbox-public/api/-/merge_requests/43/diffs?diff_id=36016&start_sha=3277b7a5e62a6d6e499b122a591fcb64ae41d7c6)
kirill commented 2026-08-14 04:03:03 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

🟡 Warning: Перепутаны значения статусов отмены заказа

File: v2/swagger.yaml

Problem: документация указывает 3=CANCELED_USER, 4=CANCELED_MANAGER, но backend enum ShopOrderStatus определяет наоборот: STATUS_CANCELED_MANAGER = 3, STATUS_CANCELED_USER = 4.

- 3=CANCELED_USER, 4=CANCELED_MANAGER
+ 3=CANCELED_MANAGER, 4=CANCELED_USER

Suggested fix: исправить описание параметра order_status_id и проверить остальные упоминания этих статусов в схемах/описаниях.

Why: клиент, сгенерированный или реализованный по Swagger, будет неверно фильтровать и интерпретировать отменённые заказы.

### 🟡 Warning: Перепутаны значения статусов отмены заказа **File:** `v2/swagger.yaml` **Problem:** документация указывает `3=CANCELED_USER, 4=CANCELED_MANAGER`, но backend enum `ShopOrderStatus` определяет наоборот: `STATUS_CANCELED_MANAGER = 3`, `STATUS_CANCELED_USER = 4`. ```diff - 3=CANCELED_USER, 4=CANCELED_MANAGER + 3=CANCELED_MANAGER, 4=CANCELED_USER ``` **Suggested fix:** исправить описание параметра `order_status_id` и проверить остальные упоминания этих статусов в схемах/описаниях. **Why:** клиент, сгенерированный или реализованный по Swagger, будет неверно фильтровать и интерпретировать отменённые заказы.
kirill commented 2026-08-14 04:03:16 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

changed the description

changed the description
kirill commented 2026-08-14 04:27:13 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

added 1 commit

  • 6c898016 - H-2626: исправить статусы заказов в Swagger

Compare with previous version

added 1 commit <ul><li>6c898016 - H-2626: исправить статусы заказов в Swagger</li></ul> [Compare with previous version](/hrbox-public/api/-/merge_requests/43/diffs?diff_id=37059&start_sha=9820f97216044536c39cc7a2431a360524663f14)
kirill commented 2026-08-14 04:27:38 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

resolved all threads

resolved all threads
kirill commented 2026-08-14 04:27:40 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

changed the description

changed the description
anton commented 2026-08-20 08:06:37 +00:00 (Migrated from git.hrenot.com)
Copy Link
Copy Source

added 1 commit

  • 278463e6 - H-2626: Правки после ревью

Compare with previous version

added 1 commit <ul><li>278463e6 - H-2626: Правки после ревью</li></ul> [Compare with previous version](/hrbox-public/api/-/merge_requests/43/diffs?diff_id=37425&start_sha=6c8980162c7c9cdf85467563ae65c5baff51300c)
You are not authorized to merge this pull request.
This pull request can be merged automatically.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin feature/H-2626:feature/H-2626
git checkout feature/H-2626
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
denis gnome627 (Дмитрий Сащенко) kirill ruslan yuriy
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: hrbox-public/api#43