diff --git a/docs/README.md b/docs/README.md index 5c4b4d5..482e6b1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,48 @@ -# Page +--- +icon: face-confounded +coverY: 0 +--- +# The invitation code RU + +### Что это такое + +**Код приглашения** — это временный механизм доступа, действующий на этапах **альфа-** и **бета-тестирования** мессенджера **Говор**.\ +Он используется для **ограничения количества аккаунтов** и **контроля числа пользователей**, получающих ранний доступ к продукту. + +Пока Говор находится в стадии активной разработки и внутреннего тестирования, регистрация новых пользователей возможна **только при наличии действующего кода приглашения**. + +### Как получить код приглашения + +Коды приглашения **создаются администрацией проекта** и **выдаются вручную** по мере готовности новых тестовых слотов. + +Чтобы запросить код приглашения: + +1. Свяжитесь с командой разработчиков. +2. Кратко опишите, зачем вы хотите протестировать Говор. +3. Дождитесь ответа с вашим уникальным кодом. + +📩 **Контакт для запроса:**\ +`BurntRoostersOfficial@protonmail.com` + +### Как выглядит код + +Код приглашения представляет собой **уникальный случайно сгенерированный идентификатор** (объект `Guid`).\ +Пример: + +``` +c7a5f1b3-8c64-47e2-9e3e-b7df6a2b021f +``` + +### Ограничения + +Каждый код приглашения имеет: + +* 🔹 **Ограниченное количество регистраций.**\ + После достижения лимита использование кода становится невозможным. +* ⏳ **Ограниченный срок действия.**\ + По истечении времени жизни код автоматически теряет актуальность. + +### После официального релиза + +После выхода **первой стабильной версии Говора** система кодов приглашений будет **отключена**, и регистрация станет **открытой для всех пользователей**. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 8885cc7..1403c18 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,29 +1,29 @@ # Table of contents -* [Page](README.md) +* [The invitation code RU](README.md) ## Endpoints -* [Authentication](../docs/endpoints/authentication/README.md) - * [AuthController](../docs/endpoints/authentication/authcontroller.md) - * [RefreshController](../docs/endpoints/authentication/refreshcontroller.md) -* [SessionController](../docs/endpoints/sessioncontroller.md) -* [FriendshipController](../docs/endpoints/friendshipcontroller.md) -* [FriendsRequestQueryController](../docs/endpoints/friendsrequestquerycontroller.md) -* [MediaController](../docs/endpoints/mediacontroller.md) -* [ChatLoadController](../docs/endpoints/chatloadcontroller.md) -* [OnlinePingingController(не работает)](../docs/endpoints/onlinepingingcontroller-ne-rabotaet.md) +* [Authentication](endpoints/authentication/README.md) + * [AuthController](endpoints/authentication/authcontroller.md) + * [RefreshController](endpoints/authentication/refreshcontroller.md) +* [SessionController](endpoints/sessioncontroller.md) +* [FriendshipController](endpoints/friendshipcontroller.md) +* [FriendsRequestQueryController](endpoints/friendsrequestquerycontroller.md) +* [MediaController](endpoints/mediacontroller.md) +* [ChatLoadController](endpoints/chatloadcontroller.md) +* [OnlinePingingController(не работает)](endpoints/onlinepingingcontroller-ne-rabotaet.md) ## SignalR -* [PresenceHub](../docs/signalr/presencehub.md) -* [ChatHub](../docs/signalr/chathub.md) +* [PresenceHub](signalr/presencehub.md) +* [ChatHub](signalr/chathub.md) *** -* [FriendsHub](../docs/friendshub/README.md) - * [FriendsHub Client (Java)](../docs/friendshub/friendshub-client-java.md) +* [FriendsHub](friendshub/README.md) + * [FriendsHub Client (Java)](friendshub/friendshub-client-java.md) -## Code Docs +## Code Docs -* [HubResult\](../docs/code-docs/hubresult-less-than-t-greater-than.md) +* [HubResult\](code-docs/hubresult-less-than-t-greater-than.md) diff --git a/docs/endpoints/sessioncontroller.md b/docs/endpoints/sessioncontroller.md index afb2b05..abdc3b8 100644 --- a/docs/endpoints/sessioncontroller.md +++ b/docs/endpoints/sessioncontroller.md @@ -75,6 +75,37 @@ description: >- "Unexpected Error! Please try again later." ``` +#### CloseSession + +* **Description**: Closes a current session for the authenticated user. +* **Route**: `[DELETE] api/session/close/` +* **HTTP Method**: `DELETE` +* **Request**: + * No body. +* **Responses**: + * **200 OK**: Indicates session was successfully closed. + * No body. + * **400 Bad Request**: If `sessionId` is invalid or operation fails. + + ```json + "string" + ``` + * **403 Forbidden**: If user lacks authorization. + + ```json + "string" + ``` + * **404 Not Found**: If session is not found. + + ```json + "string" + ``` + * **500 Internal Server Error**: Indicates an unexpected error. + + ```json + "Unexpected Error! Please try again later." + ``` + #### CloseAllSessions * **Description**: Closes all active sessions for the authenticated user. @@ -89,7 +120,7 @@ description: >- ```json "string" ``` - * **500 Internal Server Error**: Indicates an unexpected error. + * **500 Internal Server Error**: Indicates an unexpected error. ```json "Unexpected Error! Please try again later."