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

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
+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` из корня репозитория.