Ещё несколько исправлений

AuroraTeam · Feb 18, 2024 · a32a54a · a32a54a
1 parent 176531e
commit a32a54a
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 29 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -15,10 +15,10 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Cache node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

diff --git a/docs/basic/auth.md b/docs/basic/auth.md
@@ -50,7 +50,7 @@ auth:
 ```
 
 ::: info Для уточнения:
-Для того, что бы данный тип аутентификации работал, вы должны реализовать [следующие запросы](/docs/for-developers/json-auth.md) в своём API.
+Для того, что бы данный тип аутентификации работал, вы должны реализовать [следующие запросы](/for-developers/json-auth.md) в своём API.
 :::
 
 ## Настройка типа `DB`

diff --git a/docs/for-developers/json-auth.md b/docs/for-developers/json-auth.md
@@ -2,92 +2,131 @@
 
 Здесь описаны запросы которые вы должны реализовать на вашем сервисе для успешной авторизации в лаунчере.
 
+Ответы на запросы должны придерживаться следующего формата:
+
+```json
+// Успешный запрос
+{
+  "success": true,
+  "result": ...
+}
+// гдe, result - тело ответа
+
+// Ошибка
+{
+  "success": false,
+  "error": "Сообщение об ошибке"
+}
+```
+
+Пример реализации запросов: [easy-cabinet-backend](https://github.com/AuroraTeam/easy-cabinet-backend/tree/master/src/aurora)
+
 ## `POST` /auth
 
 Запрос:
+
 ```json
 {
-    "username": "Имя пользователя",
-    "password": "Пароль пользователя"
+  "login": "Имя пользователя",
+  "password": "Пароль пользователя"
 }
 ```
 
 Ответ:
+
 ```json
 {
-    "username": "Имя пользователя",
-    "userUUID": "UUID пользователя",
-    "accessToken": "accessToken пользователя"
+  "username": "Имя пользователя",
+  "userUUID": "UUID пользователя",
+  "accessToken": "accessToken пользователя",
+  "isAlex": false, // Тонкий скин или нет
+  "skinUrl": "URL адрес до файла скина",
+  "capeUrl": "URL адрес до файла плаща"
 }
+// Поля isAlex, skinUrl, capeUrl - опциональные
 ```
 
 ## `POST` /join
 
 Запрос:
+
 ```json
 {
-    "accessToken": "accessToken пользователя",
-    "userUUID": "UUID пользователя",
-    "serverID": "serverID пользователя"
+  "accessToken": "accessToken пользователя",
+  "userUUID": "UUID пользователя",
+  "serverID": "serverID пользователя"
 }
 ```
 
 Ответ:
+
 ```json
-{
-"boolean"
-}
+boolean // true - успешная авторизация
 ```
 
 ## `POST` /hasJoined
 
 Запрос:
+
 ```json
 {
-    "username": "Имя пользователя",
-    "serverID": "serverID пользователя"
+  "username": "Имя пользователя",
+  "serverID": "serverID пользователя"
 }
 ```
 
 Ответ:
+
 ```json
 {
-    "userUUID": "UUID пользователя",
-    "skinUrl": "URL адрес до файла скина",
-    "capeUrl": "URL адрес до файла плаща"
+  "userUUID": "UUID пользователя",
+  "isAlex": false, // Тонкий скин или нет
+  "skinUrl": "URL адрес до файла скина",
+  "capeUrl": "URL адрес до файла плаща"
 }
+// Поля isAlex, skinUrl, capeUrl - опциональные
 ```
 
 ## `POST` /profile
 
 Запрос:
+
 ```json
 {
-    "userUUID": "UUID пользователя"
+  "userUUID": "UUID пользователя"
 }
 ```
 
 Ответ:
+
 ```json
 {
-    "userUUID": "UUID пользователя",
-    "skinUrl": "URL адрес до файла скина",
-    "capeUrl": "URL адрес до файла плаща"
+  "username": "Имя пользователя",
+  "isAlex": false, // Тонкий скин или нет
+  "skinUrl": "URL адрес до файла скина",
+  "capeUrl": "URL адрес до файла плаща"
 }
+// Поля isAlex, skinUrl, capeUrl - опциональные
 ```
 
-## `POST` /profiles  //Я чё то не понял код запроса
+## `POST` /profiles
 
 Запрос:
+
 ```json
 {
-
+  usernames: ["Имя пользователя 1", "Имя пользователя 2", ...]
 }
 ```
 
 Ответ:
-```json
-{
 
-}
-```
+```json
+[
+  {
+    "id": "UUID пользователя",
+    "name": "Имя пользователя"
+  },
+  ...
+]
+```