@@ -4,15 +4,16 @@ module.exports = {
4
4
schema : {
5
5
register : {
6
6
public : true ,
7
- description : 'Регистрация' ,
7
+ description : 'Регистрация нового пользователя с ролью user. ' ,
8
8
params : {
9
9
required : [ 'username' , 'password' ] ,
10
10
properties : {
11
11
username : {
12
12
type : 'string' ,
13
- description : 'Имя пользователя'
13
+ description : 'Имя пользователя. '
14
14
} ,
15
15
password : {
16
+ description : 'Пароль.' ,
16
17
type : 'string'
17
18
}
18
19
}
@@ -21,12 +22,15 @@ module.exports = {
21
22
required : [ 'username' , 'role' , 'createdTime' ] ,
22
23
properties : {
23
24
username : {
25
+ description : 'Имя пользователя.' ,
24
26
type : 'string'
25
27
} ,
26
28
role : {
29
+ description : 'Роль пользователя.' ,
27
30
type : 'string'
28
31
} ,
29
32
createdTime : {
33
+ description : 'Временная метка создания пользователя.' ,
30
34
type : 'string'
31
35
}
32
36
}
@@ -35,13 +39,16 @@ module.exports = {
35
39
} ,
36
40
login : {
37
41
public : true ,
42
+ description : 'Аутентификация пользователя.' ,
38
43
params : {
39
44
required : [ 'username' , 'password' ] ,
40
45
properties : {
41
46
username : {
47
+ description : 'Имя пользователя.' ,
42
48
type : 'string'
43
49
} ,
44
50
password : {
51
+ description : 'Пароль.' ,
45
52
type : 'string'
46
53
}
47
54
}
@@ -50,12 +57,15 @@ module.exports = {
50
57
required : [ 'username' , 'role' , 'createdTime' ] ,
51
58
properties : {
52
59
username : {
60
+ description : 'Имя пользователя.' ,
53
61
type : 'string'
54
62
} ,
55
63
role : {
64
+ description : 'Роль пользователя.' ,
56
65
type : 'string'
57
66
} ,
58
67
createdTime : {
68
+ description : 'Временная метка создания пользователя.' ,
59
69
type : 'string'
60
70
}
61
71
}
@@ -64,37 +74,46 @@ module.exports = {
64
74
} ,
65
75
logout : {
66
76
public : false ,
77
+ description : 'Выход пользователя из системы.' ,
67
78
transport : 'http'
68
79
} ,
69
80
me : {
70
81
public : false ,
82
+ description : 'Получение данных о текущем пользователе.' ,
71
83
result : {
72
84
required : [ 'username' , 'role' , 'createdTime' ] ,
73
85
properties : {
74
86
username : {
87
+ description : 'Имя пользователя.' ,
75
88
type : 'string'
76
89
} ,
77
90
role : {
91
+ description : 'Роль пользователя.' ,
78
92
type : 'string'
79
93
} ,
80
94
createdTime : {
95
+ description : 'Временная метка создания пользователя.' ,
81
96
type : 'string'
82
97
}
83
98
}
84
99
}
85
100
} ,
86
101
changePassword : {
87
102
public : false ,
103
+ description : 'Смена пароля текущего пользователя.' ,
88
104
params : {
89
105
required : [ 'username' , 'oldPassword' , 'newPassword' ] ,
90
106
properties : {
91
107
username : {
108
+ description : 'Имя пользователя.' ,
92
109
type : 'string'
93
110
} ,
94
111
oldPassword : {
112
+ description : 'Старый пароль.' ,
95
113
type : 'string'
96
114
} ,
97
115
newPassword : {
116
+ description : 'Новый пароль.' ,
98
117
type : 'string'
99
118
}
100
119
}
@@ -103,12 +122,15 @@ module.exports = {
103
122
required : [ 'username' , 'role' , 'createdTime' ] ,
104
123
properties : {
105
124
username : {
125
+ description : 'Имя пользователя.' ,
106
126
type : 'string'
107
127
} ,
108
128
role : {
129
+ description : 'Роль пользователя.' ,
109
130
type : 'string'
110
131
} ,
111
132
createdTime : {
133
+ description : 'Временная метка создания пользователя.' ,
112
134
type : 'string'
113
135
}
114
136
}
0 commit comments