Актуализировать документацию и навигацию для агентов

This commit is contained in:
AidarKC
2026-11-05 22:50:31 +03:00
parent 3c6021a290
commit 4f8c2a72e9
31 changed files with 315 additions and 927 deletions
+3 -3
View File
@@ -7,7 +7,7 @@
- `GetUser` — временная серверная проверка существования пользователя и чтение его базовых данных;
- `SearchUsers` — dev/test поиск логинов по префиксу, при необходимости с фильтром только по server PDA.
Регистрация выполняется только через Solana.
Регистрация платного аккаунта выполняется через Solana; для бесплатного namespace также зарегистрирован отдельный flow с email-кодом и сертификатом Arweave (см. раздел «Регистрация V2» ниже).
## Статус документа
@@ -170,12 +170,12 @@
- `GetUser` — проверка существования пользователя на сервере.
- `SearchUsers` — временный поиск пользователей по префиксу.
- Регистрация выполняется только через Solana.
- Регистрация платного аккаунта выполняется через Solana; для бесплатного namespace также зарегистрирован отдельный flow с email-кодом и сертификатом Arweave (см. раздел «Регистрация V2» ниже).
## Регистрация V2: полные логины и независимые проверки
Публичные WS-операции нового протокола перечислены в `docs/registration-v2/WS_REGISTRATION_V2_PROPOSED_NOT_ENABLED.md`.
Публичные WS-операции нового протокола перечислены в [контракте регистрации v2](../registration-v2/WS_REGISTRATION_V2_API.md).
Сначала `GetNamespaces` → `CheckRegistrationLogin` с полным `login@namespace`; затем **только для бесплатной регистрации** отдельное `CheckRegistrationEmail`. После проверки запускается `StartFreeRegistration`, затем `ConfirmFreeRegistration` с шестизначным одноразовым кодом из письма (1 час, 5 попыток). Состояние читается через `GetRegistrationStatus`.
Все бесплатные сертификаты подписаны ANS-104 и внутренней подписью Ed25519; успешный Turbo ACK не означает подтверждённую высоту Arweave. Клиент никогда не отправляет пароль или приватные ключи на сервер.
+18 -2
View File
@@ -12,6 +12,12 @@
| Операция | Раздел документации | Кратко |
| --- | --- | --- |
| `GetNamespaces` | `01_User_Registration_API.md` | список namespace для регистрации |
| `CheckRegistrationLogin` | `01_User_Registration_API.md` | проверка полного логина |
| `CheckRegistrationEmail` | `01_User_Registration_API.md` | проверка доступности email |
| `StartFreeRegistration` | `01_User_Registration_API.md` | начало бесплатной регистрации с email-кодом |
| `ConfirmFreeRegistration` | `01_User_Registration_API.md` | подтверждение кода и выпуск сертификата |
| `GetRegistrationStatus` | `01_User_Registration_API.md` | статус регистрации |
| `GetUser` | `01_User_Registration_API.md` | чтение/проверка пользователя + server-состояние его блокчейна |
| `SearchUsers` | `01_User_Registration_API.md` | поиск логинов и публичных имён пользователей |
| `SearchChannels` | `06_Channels_Read_API.md` | поиск публичных каналов по названию, slug и логину владельца |
@@ -20,6 +26,13 @@
| `CreateAuthSession` | `02_Authentication_API.md` | создание новой авторизованной сессии |
| `SessionChallenge` | `02_Authentication_API.md` | challenge для входа в существующую сессию |
| `SessionLogin` | `02_Authentication_API.md` | вход в существующую сессию |
| `UpsertEspPairingSettings` | `03_Session_Management_API.md` | альтернативное имя настройки pairing; тот же обработчик, что `UpsertTrustedDeviceLoginSettings` |
| `StartEspPairing` | `03_Session_Management_API.md` | альтернативное имя начала pairing |
| `ListEspPairingRequests` | `03_Session_Management_API.md` | альтернативное имя списка заявок |
| `ApproveEspPairing` | `03_Session_Management_API.md` | альтернативное имя подтверждения |
| `RejectEspPairing` | `03_Session_Management_API.md` | альтернативное имя отклонения |
| `CancelEspPairing` | `03_Session_Management_API.md` | альтернативное имя отмены |
| `GetEspPairingStatus` | `03_Session_Management_API.md` | альтернативное имя чтения статуса |
| `GetTrustedDeviceLoginSettings` | `03_Session_Management_API.md` | чтение текущего режима входа через доверенное устройство |
| `UpsertTrustedDeviceLoginSettings` | `03_Session_Management_API.md` | включение/обновление pairing-настроек доверенной сессией |
| `StartTrustedDeviceLogin` | `03_Session_Management_API.md` | создание pairing-заявки для нового устройства |
@@ -56,6 +69,9 @@
| `GetMessageThread` | `06_Channels_Read_API.md` | тред сообщения |
| `GetMessageLikes` | `06_Channels_Read_API.md` | списки пользователей, поставивших лайк сообщению |
| `GetPersonalDiary` | `06_Channels_Read_API.md` | виртуальный канал `Личный дневник` из STATUS_ACTION |
| `ListUserProfileChannels` | `06_Channels_Read_API.md` | публичные каналы профиля |
| `ListUserProfileRelations` | `11_Connections_API.md` | связи пользователя в профиле |
| `GetUserCounters` | `17_User_Counters_API.md` | счётчики пользователя |
| `GetChannelsCounters` | `06_Channels_Read_API.md` | счетчики разделов каналов |
| `SetChannelReadState` | `06_Channels_Read_API.md` | подписанный watermark чтения канала |
| `ListGroupChats200` | `06_Channels_Read_API.md` | список групповых чатов типа `200` |
@@ -93,7 +109,7 @@
- `ServerHello` пока принимает заявленный `serverLogin` на доверии и не является криптографической аутентификацией.
- HTTP endpoints зашифрованных DM-файлов (`PUT/GET/HEAD/OPTIONS /dm-files/{fileId}`) не являются WebSocket `op` и описаны отдельно в `18_DM_File_Storage_API.md`.
- HTTP endpoints публичных content-addressed файлов (`PUT/GET/HEAD/OPTIONS /files/{sha256}`) также не являются WebSocket `op` и описаны отдельно в `21_Public_File_Storage_API.md`.
- Классы `Net_MarkChannelMessagesSeen_*` существуют в коде, но операция `MarkChannelMessagesSeen` не зарегистрирована в `JsonHandlerRegistry`, поэтому в публичный список API не входит.
- Закомментированный `ListSubscribedChannels` не зарегистрирован и не входит в публичный API. Классы `Net_MarkChannelMessagesSeen_*` существуют в коде, но операция `MarkChannelMessagesSeen` не зарегистрирована в `JsonHandlerRegistry`, поэтому в публичный список API не входит.
- HTTP debug endpoints из `src/main/java/server/debug/` не входят в этот индекс WebSocket `op`; они описаны отдельно в `13_HTTP_Debug_API.md`.
@@ -106,7 +122,7 @@
- `ConfirmFreeRegistration` — подтверждение тестовым кодом и Turbo ACK;
- `GetRegistrationStatus` — статус и публичные поля сертификата для upgrade.
Точный JSON и ограничения: `docs/registration-v2/WS_REGISTRATION_V2_PROPOSED_NOT_ENABLED.md` (имя сохранено для обратных ссылок; внутри утверждённая версия).
Точный JSON и ограничения: [контракт регистрации v2](../registration-v2/WS_REGISTRATION_V2_API.md).
### `GetRegistrationStatus` после DB v35
+16
View File
@@ -0,0 +1,16 @@
# API сервера SHiNE
Сервер принимает JSON-операции по WebSocket. Точный общий конверт описан в [общем формате](00_Common_API_Format.md); зарегистрированные имена `op` — в [индексе операций](09_Operations_Index.md). Источник списка в коде: `SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/JsonHandlerRegistry.java`.
| Раздел | Документы |
| --- | --- |
| Регистрация и вход | [регистрация](01_User_Registration_API.md), [аутентификация](02_Authentication_API.md), [сессии и pairing](03_Session_Management_API.md) |
| Блокчейн и ключи | [AddBlock](04_Add_Block_to_Blockchain_API.md), [ротация ключей](19_Key_Rotation_API.md), [собственная цепочка](20_Get_My_Blockchain_API.md) |
| Каналы и профиль | [чтение каналов](06_Channels_Read_API.md), [связи](11_Connections_API.md), [счётчики](17_User_Counters_API.md) |
| Личные сообщения | [DM, push и звонки](12_Direct_Messages_Push_Calls_API.md), [HTTP-файлы DM](18_DM_File_Storage_API.md) |
| Настройки и система | [технические операции](05_Technical_Requests_API.md), [параметры](10_User_Params_API.md), [настройки](13_User_Settings_API.md), [уведомления](15_Notifications_API.md) |
| Отдельные HTTP endpoint | [публичные файлы](21_Public_File_Storage_API.md), [debug](13_HTTP_Debug_API.md) |
Зарегистрированное имя `op` означает наличие обработчика, но не гарантирует доступность функции на каждом сервере: часть возможностей зависит от конфигурации, сети и состояния миграций. Сведения о текущей регистрации по email — в [профильном документе](../registration-v2/RESEND_EMAIL_VERIFICATION.md). Старые планы регистрации описывают прежние этапы.
При изменении `JsonHandlerRegistry` обновите профильный документ и индекс. После изменения документации запустите `python3 scripts/check_docs.py` из корня репозитория.