Убрал разговорные обороты («главный кейс», «уволенные», «совместительства»,
«юзер», «UUID юзера», «то самое значение», «cross-tenant», «нет права»,
«ilike-поиск»). Описания параметров, полей схемы и ответов
переведены в нейтральный документационный регистр без жаргона
и эмоциональной разметки.
Технический смысл сохранён полностью — изменения только стилистические.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Новый admin read-only API трудоустройств. Основной кейс —
маппинг (origin_id, origin_organization_id) → user_id для
интеграторов (web-zaim, sokolove и др.).
- Тег admin-employment (Methods for admin read-only access...).
- GET /admin/employment: index с полным набором фильтров
EmploymentSearch (origin_id[], origin_organization_id, user_id[],
department_id, chief_id, is_main, status_id, reg_status_id,
employment_date/fired_date/created_at range, name/position ilike,
user_list_key, chief_only*, multipleEmployment).
- GET /admin/employment/view?id=<uuid>: одна запись.
- Доступ: user-edit (тот же perm что в legacy /api/employment v1).
- Схемы AdminEmployment, AdminEmploymentList, AdminEmploymentUserShort,
AdminEmploymentChiefUserShort, AdminEmploymentDepartmentShort.
- В описании метода — главный кейс маппинга origin → user_id,
совместительства, поведение uvol'нённых, батч origin_id[].
Источники: контроллер app\controllers\api\v2\admin\EmploymentController,
testrix tests/v2/admin/test_admin_employment.py +
hrbox/models/v2/AdminEmploymentModel.py (pydantic).
Проверено живьём на denis.hrbox.io: totalCount=9393, все поля
схемы совпадают с реальным ответом.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Соглашение: info.description и теги — короткое EN (как workflow,
wallet и др.), а внутри самого метода (summary + description) —
русский, потому что туда смотрит уже сам интегратор и важно дать
максимально понятный how-to. Возвращаю русский для
POST /user-api-token/create.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- info.description: убрал большой блок «Авторизация по личному API-токену»
(он висел на стартовой странице Swagger UI). Вместо него — одна
английская строка-указатель на user-api-token methods, в стиле
остального вступления.
- BearerAuth securityScheme: однострочное EN-описание.
- Теги admin-wallet, admin-wallet-transaction, file-processing,
user-api-token, admin-user-api-token: переведены в формат
«Methods for ...» (как workflow, wallet, shop и т.д.) — короткая
английская строка на тег.
- POST /user-api-token/create description: подробный how-to (создание,
Bearer-header, tenant-резолв, отсутствие scopes, lifecycle,
isValidForDisplay-caveat, запрет на управление под Bearer) — теперь
лежит здесь, на английском, и сворачивается в UI вместе с эндпоинтом.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Listing-схемы (Wallet/WalletTransaction/FileProcessing/UserApiToken{,Admin}):
добавил optional поле `_links` — оно реально возвращается Yii Pagination
на index-эндпоинтах и без него клиент-генератор не видит поле.
- FileProcessing: дополнил схему полями, которые реально приходят в
ответе без `?expand=`:
* `file` — объект с метаданными файла-источника (name, ext, url, ...)
* `created`/`started`/`finished` — локализованные строки для отображения
Уточнил `arguments` и `result` (oneOf object/array).
Все остальные эндпоинты (admin/wallet[/view], admin/wallet-transaction[/view],
admin/wallet-transaction/{create,create-from-excel,excel-processing},
file-processing[/view], user-api-token, admin/user-api-token) после
прогона smoke-теста соответствуют документации:
- response shape ↔ schema
- 400 на not-uuid id
- 404 на несуществующий id
- per-page>100 clamps к 100
- 200 с {success:false, errors:[...]} на пустой POST
- 200 с {success:false, message:{type:warning, text:"Обработка файла не найдена"}}
на несуществующий file_processing_id
- 403 на /user-api-token и /admin/user-api-token под Bearer
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
При тестировании наткнулся на 401 «Login Required» с валидным
live-токеном, потому что у юзера-владельца стоял is_hidden=true.
findIdentityByAccessToken после поиска токена ещё прогоняет
User::isValidForDisplay() — это надо явно упоминать в how-to,
иначе интегратор не поймёт почему не работает.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Фронтенд (frontend/src/api/userApiToken/HRUserApiTokenApi.ts:18) зовёт
именно `${baseUrl}/create`, а не RESTful `POST /user-api-token`.
Оба роута маршрутизируются Yii в actionCreate, но в swagger лучше
документировать тот же путь, что использует прод-клиент — для
консистентности с /admin/wallet-transaction/create.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- info.description: подробная how-to секция «Авторизация по личному API-токену»
(создание, формат Bearer-заголовка, tenant-резолв, отсутствие scopes,
жизненный цикл и автo-revoke при блокировке юзера, запрет на управление
под Bearer).
- securitySchemes.BearerAuth: новая схема http/bearer (PAT).
- security (global): + BearerAuth, чтобы Try-it-out предлагал три способа auth.
- Теги user-api-token и admin-user-api-token.
- Эндпоинты:
* GET /user-api-token, POST /user-api-token, POST /user-api-token/revoke
* GET /admin/user-api-token, POST /admin/user-api-token/revoke
Все management-эндпоинты помечены `security: SessionAuth` и явно
документируют 403 под Bearer (защита от рекурсии).
- Схемы: UserApiToken, UserApiTokenList, UserApiTokenCreated (с plain),
UserApiTokenCreateForm, UserApiTokenAdmin (+ user/updatedByUser),
UserApiTokenAdminList, UserApiTokenStatus.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
