Документировать API и сервис агента-кодера

2026-05-24 08:04:44 +03:00
parent aa2644d812
commit 4b371e142d
53 changed files with 4317 additions and 18 deletions
@@ -2,10 +2,11 @@

 Этот файл описывает временный раздел API, связанный с заведением пользователя на сервере и проверкой, существует ли пользователь.

-Сейчас здесь два метода:
+Сейчас здесь три метода:

 - `AddUser` — временная серверная регистрация пользователя;
- `GetUser` — временная серверная проверка существования пользователя и чтение его базовых данных.
+- `GetUser` — временная серверная проверка существования пользователя и чтение его базовых данных;
+- `SearchUsers` — dev/test поиск логинов по префиксу.

 Их логика пока вспомогательная и dev-oriented: сервер сам хранит эти данные локально и сам отвечает на existence-check. В будущем оба сценария должны быть заменены на нормальную работу напрямую через Solana, но пока этот контракт нужен клиентам для разработки и интеграции.

@@ -166,8 +167,49 @@

 ---

-## 3. Короткое резюме
+## 3. Операция `SearchUsers`
+
+### Назначение
+
+Поиск пользователей по префиксу логина. Операция зарегистрирована в серверном API и используется как вспомогательная dev/test операция.
+
+### Запрос
+
+```json
+{
+  "op": "SearchUsers",
+  "requestId": "search-001",
+  "payload": {
+    "prefix": "an"
+  }
+}
+```
+
+### Успешный ответ
+
+```json
+{
+  "op": "SearchUsers",
+  "requestId": "search-001",
+  "status": 200,
+  "ok": true,
+  "payload": {
+    "logins": ["anya", "andrey"]
+  }
+}
+```
+
+### Специфические коды ошибок `SearchUsers`
+
+- `400 / BAD_FIELDS` — некорректный или пустой `prefix`.
+- `501 / DB_ERROR` — ошибка БД при поиске.
+- `500 / INTERNAL_ERROR` — непредвиденная внутренняя ошибка сервера.
+
+---
+
+## 4. Короткое резюме

 - `AddUser` — временная регистрация пользователя на сервере.
 - `GetUser` — временная проверка существования пользователя на сервере.
+- `SearchUsers` — временный поиск пользователей по префиксу.
 - И регистрация, и existence-check позже должны быть переведены на Solana.