drogon-auth/openapi.yaml at master · capybaracplusplus/drogon-auth · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
openapi: 3.0.0
info:
  title: Authentication API
  description: API для аутентификации пользователей
  version: 1.0.0
paths:
  /sign-up:
    post:
      summary: Регистрация нового пользователя
      operationId: signUp
      tags:
        - Auth
      requestBody:
        description: Данные для регистрации нового пользователя
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - username
                - email
                - password
              properties:
                username:
                  type: string
                  description: Имя пользователя
                email:
                  type: string
                  format: email
                  description: Электронная почта пользователя
                password:
                  type: string
                  description: Пароль пользователя
      responses:
        '201':
          description: Пользователь успешно зарегистрирован
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "user registered successfully"
        '400':
          description: Неверные данные
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: "Required fields (username or email) are missing"

  /sign-in:
    post:
      summary: Вход пользователя
      operationId: signIn
      tags:
        - Auth
      requestBody:
        description: Данные для входа
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - username
                - password
              properties:
                username:
                  type: string
                  description: Имя пользователя
                password:
                  type: string
                  description: Пароль пользователя
      responses:
        '200':
          description: Успешный вход
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "The user has successfully logged into the account"
                  accessToken:
                    type: string
                    description: Новый access token
                  userId:
                    type: integer
                    description: Идентификатор пользователя
        '400':
          description: Неверные данные для входа
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: "Invalid username or password"

  /logout:
    post:
      summary: Выход пользователя
      operationId: logout
      tags:
        - Auth
      responses:
        '200':
          description: Пользователь успешно вышел
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "The user has successfully logged out of the account."
                  logout:
                    type: string
                    example: "ok"
        '401':
          description: Неверный токен
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: "Access token is not valid"

  /getNewAccessToken:
    post:
      summary: Получить новый access token
      operationId: getNewAccessToken
      tags:
        - Auth
      requestBody:
        description: Токены для получения нового access token
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - accessToken
                - refreshToken
              properties:
                accessToken:
                  type: string
                  description: Текущий access token
                refreshToken:
                  type: string
                  description: Текущий refresh token
      responses:
        '200':
          description: Новый access token получен успешно
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "The user has successfully updated the access token"
                  accessToken:
                    type: string
                    description: Новый access token
                  userId:
                    type: integer
                    description: Идентификатор пользователя
        '400':
          description: Неверные токены
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: "Invalid tokens"

  /changePassword:
    post:
      summary: Смена пароля пользователя
      operationId: changePassword
      tags:
        - Auth
      requestBody:
        description: Новые данные для смены пароля
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - password
                - accessToken
              properties:
                password:
                  type: string
                  description: Новый пароль
                accessToken:
                  type: string
                  description: Текущий access token
      responses:
        '200':
          description: Пароль успешно изменен
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "New password set successfully"
        '400':
          description: Ошибка при изменении пароля
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: "Invalid password"

components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
  security:
    - JWT: []