Skip to content

Commit 83da562

Browse files
author
DanilSord
committed
fix: descriptions for auth schema.
1 parent ccdb9c2 commit 83da562

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

lib/auth-module.js

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ module.exports = {
44
schema: {
55
register: {
66
public: true,
7-
description: 'Регистрация',
7+
description: 'Регистрация нового пользователя с ролью user.',
88
params: {
99
required: ['username', 'password'],
1010
properties: {
1111
username: {
1212
type: 'string',
13-
description: 'Имя пользователя'
13+
description: 'Имя пользователя.'
1414
},
1515
password: {
16+
description: 'Пароль.',
1617
type: 'string'
1718
}
1819
}
@@ -21,12 +22,15 @@ module.exports = {
2122
required: ['username', 'role', 'createdTime'],
2223
properties: {
2324
username: {
25+
description: 'Имя пользователя.',
2426
type: 'string'
2527
},
2628
role: {
29+
description: 'Роль пользователя.',
2730
type: 'string'
2831
},
2932
createdTime: {
33+
description: 'Временная метка создания пользователя.',
3034
type: 'string'
3135
}
3236
}
@@ -35,13 +39,16 @@ module.exports = {
3539
},
3640
login: {
3741
public: true,
42+
description: 'Аутентификация пользователя.',
3843
params: {
3944
required: ['username', 'password'],
4045
properties: {
4146
username: {
47+
description: 'Имя пользователя.',
4248
type: 'string'
4349
},
4450
password: {
51+
description: 'Пароль.',
4552
type: 'string'
4653
}
4754
}
@@ -50,12 +57,15 @@ module.exports = {
5057
required: ['username', 'role', 'createdTime'],
5158
properties: {
5259
username: {
60+
description: 'Имя пользователя.',
5361
type: 'string'
5462
},
5563
role: {
64+
description: 'Роль пользователя.',
5665
type: 'string'
5766
},
5867
createdTime: {
68+
description: 'Временная метка создания пользователя.',
5969
type: 'string'
6070
}
6171
}
@@ -64,37 +74,46 @@ module.exports = {
6474
},
6575
logout: {
6676
public: false,
77+
description: 'Выход пользователя из системы.',
6778
transport: 'http'
6879
},
6980
me: {
7081
public: false,
82+
description: 'Получение данных о текущем пользователе.',
7183
result: {
7284
required: ['username', 'role', 'createdTime'],
7385
properties: {
7486
username: {
87+
description: 'Имя пользователя.',
7588
type: 'string'
7689
},
7790
role: {
91+
description: 'Роль пользователя.',
7892
type: 'string'
7993
},
8094
createdTime: {
95+
description: 'Временная метка создания пользователя.',
8196
type: 'string'
8297
}
8398
}
8499
}
85100
},
86101
changePassword: {
87102
public: false,
103+
description: 'Смена пароля текущего пользователя.',
88104
params: {
89105
required: ['username', 'oldPassword', 'newPassword'],
90106
properties: {
91107
username: {
108+
description: 'Имя пользователя.',
92109
type: 'string'
93110
},
94111
oldPassword: {
112+
description: 'Старый пароль.',
95113
type: 'string'
96114
},
97115
newPassword: {
116+
description: 'Новый пароль.',
98117
type: 'string'
99118
}
100119
}
@@ -103,12 +122,15 @@ module.exports = {
103122
required: ['username', 'role', 'createdTime'],
104123
properties: {
105124
username: {
125+
description: 'Имя пользователя.',
106126
type: 'string'
107127
},
108128
role: {
129+
description: 'Роль пользователя.',
109130
type: 'string'
110131
},
111132
createdTime: {
133+
description: 'Временная метка создания пользователя.',
112134
type: 'string'
113135
}
114136
}

0 commit comments

Comments
 (0)