Update protected files
This commit is contained in:
cu-workflow-launcher[bot]
committed by
GitHub
GitHub
parent
baa5be9aea
commit
b9a7654830
+53
-5
@@ -47,6 +47,9 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/countryRegion"
|
||||
example:
|
||||
- Europe
|
||||
- Asia
|
||||
responses:
|
||||
"200":
|
||||
description: Список стран, соответствующих указанному фильтру. Страны должны быть отсортированы лексикографически по двухбуквенному коду.
|
||||
@@ -56,6 +59,12 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/country"
|
||||
"400":
|
||||
description: Формат входного запроса не соответствует формату либо переданы неверные значения.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/errorResponse"
|
||||
/countries/{alpha2}:
|
||||
get:
|
||||
summary: Получить страну по alpha2 коду
|
||||
@@ -161,12 +170,27 @@ paths:
|
||||
description: |
|
||||
Процедура аутентификации по логину и паролю позволяет получить токен, который в дальнейшем будет использоваться пользователем для выполнения операций, требующих авторизацию.
|
||||
|
||||
Сервер должен генерировать уникальные токены, имеющие время жизни (в рамках задачи это будет 24 часа). После истечения времени действия токен должен быть недействительным и не может использоваться для аутентификации.
|
||||
Сервер должен генерировать уникальные токены, имеющие время жизни (на усмотрение разработчика, от 1 до 24 часов). После истечения времени действия токен должен быть недействительным и не может использоваться для аутентификации.
|
||||
|
||||
Токен является уникальным строковым значением с высокой энтропией (злоумышленник не сможет его "подобрать" перебором). При каждой новой аутентификации генерируется новый уникальный токен, который ранее не был использован. Можно использовать JWT.
|
||||
|
||||
В дальнейшем полученный токен будет использоваться для авторизации пользовательских запросов. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`. Следовательно, сервер должен уметь идентифицировать пользователя по токену.
|
||||
operationId: authSignIn
|
||||
requestBody:
|
||||
description: Данные для аутентификации пользователя.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
login:
|
||||
$ref: "#/components/schemas/userLogin"
|
||||
password:
|
||||
$ref: "#/components/schemas/userPassword"
|
||||
required:
|
||||
- login
|
||||
- password
|
||||
responses:
|
||||
"200":
|
||||
description: Успешная аутентификация
|
||||
@@ -253,13 +277,36 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/errorResponse"
|
||||
"400":
|
||||
description: |
|
||||
Данные не соответствуют ожидаемому формату и требованиям.
|
||||
|
||||
Например, данную ошибку необходимо возвращать в следующих ситуациях (это не полный список):
|
||||
|
||||
- Страна с указанным кодом не найдена.
|
||||
- Длина ссылки на аватар пользователя превышает допустимый лимит.
|
||||
|
||||
Для ознакомления с форматом и требованиями к регистрационным данным обратите внимание на описание моделей в Open API спецификации.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/errorResponse"
|
||||
"409":
|
||||
description: |
|
||||
Нарушено требование на уникальность авторизационных данных пользователей.
|
||||
|
||||
Данный код ответа должен использоваться, если указанный номер телефона занят другим пользователем.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/errorResponse"
|
||||
/profiles/{login}:
|
||||
get:
|
||||
summary: Получение профиля пользователя по логину
|
||||
description: |
|
||||
Используется для получения профиля другого пользователя по логину.
|
||||
|
||||
Если профиль пользователя публичен (`isPublic: true`), его может получить любой другой пользователь. Иначе профиль пользователя получить нельзя.
|
||||
Если профиль пользователя публичен (`isPublic: true`), его может получить любой другой пользователь. Если профиль пользователя закрыт, его могут получить пользователи, которых данный пользователь добавил в друзья.
|
||||
|
||||
При этом собственный профиль пользователь может получить всегда. Сервер должен идентифицировать пользователя по переданному токену в заголовке `Authorization`.
|
||||
security:
|
||||
@@ -535,13 +582,13 @@ paths:
|
||||
$ref: "#/components/schemas/errorResponse"
|
||||
/posts/{postId}:
|
||||
get:
|
||||
summary: Получить ленту со своими постами
|
||||
summary: Получить публикацию по ID
|
||||
description: |
|
||||
Используется для получения публикации по её идентификатору.
|
||||
|
||||
Если публикация принадлежит пользователю с публичным профилем, её может получить любой другой аутентифицированный пользователь.
|
||||
|
||||
Если профиль автора закрыт, только автор может получить публикацию по ID.
|
||||
Если профиль автора закрыт, она доступна автору и пользователям, кого автор добавил в друзья.
|
||||
|
||||
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
|
||||
security:
|
||||
@@ -611,7 +658,7 @@ paths:
|
||||
Используется для получения списка публикаций другого пользователя.
|
||||
|
||||
Если профиль пользователя открыт, его посты доступны всем.
|
||||
Если профиль пользователя закрыт, его посты доступны самому пользователю и пользователям, на кого он подписан.
|
||||
Если профиль пользователя закрыт, его посты доступны самому пользователю и пользователям, кого он добавил в друзья.
|
||||
|
||||
Для плавной работы приложения используется пагинация.
|
||||
|
||||
@@ -800,6 +847,7 @@ components:
|
||||
description: Номер телефона пользователя в формате +123456789
|
||||
pattern: \+[\d]+
|
||||
example: "+74951239922"
|
||||
maxLength: 20
|
||||
userImage:
|
||||
type: string
|
||||
description: Ссылка на фото для аватара пользователя
|
||||
|
||||
Reference in New Issue
Block a user