feat(lk-contract): OpenAPI контракт lk-gateway по ESIA Finance API V1
- docs/lk-contract/v1/openapi.yaml — OpenAPI 3.0: POST/GET/PATCH /api/v1/back_office/claims, схемы Claim/CreateClaimRequest/StatusCallback/ErrorResponse - docs/lk-contract/v1/examples/claim-request.json — заявка с 3 ЦБ, ИИС T03 - docs/lk-contract/v1/examples/claim-response.json — ответ на создание - docs/lk-contract/v1/examples/callback-confirmed.json — callback подтверждения - docs/lk-contract/v1/examples/callback-rejected.json — callback отказа - docs/lk-contract/v1/examples/error-422.json — ошибка валидации - docs/lk-contract/v1/changelog.md — v1.0.0 Контракт предлагается команде реального ЛК как точка синхронизации. В lk-emulator (отдельный PR) контракт реализуется как «как-будто-ЛК» для проверки сквозного потока. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
# Changelog контракта lk-gateway
|
||||
|
||||
## v1.0.0 (2026-05-14)
|
||||
|
||||
Первая опубликованная версия контракта. Соответствует ESIA Finance
|
||||
API V1 (`DOC/API ЛК ЕСИА.pdf`).
|
||||
|
||||
Поддерживаемые операции:
|
||||
|
||||
- `POST /api/v1/back_office/claims/` — создание заявки.
|
||||
- `GET /api/v1/back_office/claims` — список с фильтрами.
|
||||
- `GET /api/v1/back_office/claims/{id}` — деталь.
|
||||
- `PATCH /api/v1/back_office/claims/{id}` — callback статуса.
|
||||
|
||||
Модели:
|
||||
|
||||
- `Claim` — заявка с массивом `securities[]` (1..N ЦБ).
|
||||
- `CreateClaimRequest` — входное тело создания.
|
||||
- `StatusCallback` — обновление статуса с `nsd_response` для аудита.
|
||||
- `ErrorResponse` — формат идентичен ESIA Finance V1.
|
||||
|
||||
Совместимость:
|
||||
|
||||
- HTTP Basic-auth.
|
||||
- UTF-8, JSON.
|
||||
- Поля enum — буквально как в XSD M2M (T12/T03, BOND/SHAR/MFUN,
|
||||
ORDN/PREF/UKWN, INFO/ERROR).
|
||||
|
||||
## Принципы версионирования
|
||||
|
||||
- Несовместимые изменения — `v2/`, `v3/` (новая папка, отдельный
|
||||
changelog).
|
||||
- Совместимые добавления — minor-версия в этом файле.
|
||||
- Документация исправлений — patch-версия в этом файле.
|
||||
Reference in New Issue
Block a user