-
Notifications
You must be signed in to change notification settings - Fork 0
/
main-service-api-v2.yaml
563 lines (563 loc) · 13.2 KB
/
main-service-api-v2.yaml
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
swagger: '2.0'
info:
description: Silent Notary API v2.0.
version: '2.0'
title: Swagger SilentNotary API v2.0
termsOfService: ''
contact:
email: [email protected]
license:
name: ''
url: 'https://silentnotary.io/license'
securityDefinitions:
Bearer:
name: Authorization
in: header
type: apiKey
description: Please enter JWT with Bearer into field
oauth:
description: When the Identity server will appear!!!
type: oauth2
authorizationUrl: 'https://auth.silentnotary.io'
flow: implicit
scopes:
'write:user': ''
'read:user': ''
host: api.silentnotary.io
basePath: /v2
tags:
- name: user
description: Application User
- name: profile
description: User profile data
- name: authentication
description: Authentication
- name: file
description: File operations
schemes:
- https
- http
paths:
/authentication/create:
post:
tags:
- authentication
operationId: Create
summary: Create a new User
consumes:
- application/json
produces:
- application/json
parameters:
- name: request
in: body
description: user credentials data
required: true
schema:
$ref: '#/definitions/UserCredentialsRequest'
responses:
'201':
description: successful created
'400':
description: User Already Registered
/authentication/login:
post:
tags:
- authentication
operationId: Login
summary: Authenticate the user
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: request
description: User credentials data
required: true
schema:
$ref: '#/definitions/UserCredentialsRequest'
responses:
'200':
description: successful login
schema:
$ref: '#/definitions/LoginResponse'
'401':
description: Invalid login data
schema:
type: object
properties:
status:
type: string
code:
type: integer
example:
message: login fail
code: 12345
/authentication/logout:
get:
tags:
- authentication
summary: User logout
operationId: Logout
responses:
'200':
description: successful logout
/authentication/activate:
put:
tags:
- authentication
summary: Activate user
operationId: Activate
consumes:
- application/json
produces:
- application/json
parameters:
- name: token
in: body
description: activation token
required: true
schema:
$ref: '#/definitions/TokenRequest'
responses:
'200':
description: ''
/profile:
get:
tags:
- profile
summary: Get current User profile data
operationId: get
produces:
- application/json
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ProfileModel'
'404':
description: User not found
security:
- Bearer: []
deprecated: true
patch:
tags:
- profile
summary: 'Update user''s profile data, such as first name, last name and email.'
operationId: Update
consumes:
- application/json
produces:
- application/json
parameters:
- name: request
in: body
description: New profile data to update
required: true
schema:
$ref: '#/definitions/ProfileModel'
responses:
'400':
description: Invalid profile data
'404':
description: User not found
security:
- Bearer: []
deprecated: true
'/user/{id}':
get:
tags:
- user
summary: Get user profile data *
operationId: getById
consumes: []
produces:
- application/json
parameters:
- name: id
in: path
description: unique user id
required: true
type: integer
format: int32
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserModel'
'400':
description: Invalid ID supplied
'404':
description: User not found
security:
- Bearer: []
post:
tags:
- user
summary: Create new user's profile data ?
operationId: create
consumes:
- application/json
produces: []
parameters:
- name: id
in: path
description: User id
required: true
type: integer
format: int32
- name: user
in: body
description: Profile data to create
required: true
schema:
$ref: '#/definitions/UserModel'
responses:
'201':
description: Successful created
'400':
description: Invalid ID supplied
'404':
description: User not found
'405':
description: Invalid input
security:
- Bearer: []
put:
tags:
- user
summary: 'Update user''s profile data, such as first name, last name, email etc. *'
operationId: update
consumes:
- application/json
parameters:
- name: id
in: path
description: User id
required: true
type: integer
format: int32
- name: user
in: body
description: Profile data to create
required: true
schema:
$ref: '#/definitions/UserModel'
responses:
'200':
description: Successful created
'400':
description: Invalid ID supplied
'404':
description: User not found
'405':
description: Invalid input
security:
- Bearer: []
'/user/{id}/accountoperations':
get:
tags:
- user
summary: Get list of user's account operations *
operationId: accountOperations
produces:
- application/json
parameters:
- name: id
in: path
description: User id
required: true
type: integer
format: int32
responses:
'200':
description: List of user's accunt operations
schema:
type: array
items:
$ref: '#/definitions/AccountOperation'
'400':
description: Invalid ID supplied
'404':
description: User not found
'405':
description: Invalid input
security:
- Bearer: []
'/user/{id}/fileoperations':
get:
tags:
- user
summary: 'Get list of user''s file operations, such as upload, download or delete '
operationId: fileOperations
produces:
- application/json
parameters:
- name: id
in: path
description: User id
required: true
type: integer
format: int32
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/FileOperation'
'400':
description: Invalid ID supplied
'404':
description: User not found
'405':
description: Invalid input
security:
- Bearer: []
'/user/{id}/bankcards':
get:
tags:
- user
summary: 'Get list of user''s bank cards '
operationId: bankcards
produces:
- application/json
parameters:
- name: id
in: path
description: User id
required: true
type: integer
format: int32
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/BankCard'
'400':
description: Invalid ID supplied
'404':
description: User not found
'405':
description: Invalid input
security:
- Bearer: []
post:
tags:
- user
summary: Add new user bank card
operationId: addBankCard
consumes:
- application/json
parameters:
- name: id
in: path
description: User id
required: true
type: integer
format: int32
- name: bankcard
in: body
description: Profile data to create
required: true
schema:
$ref: '#/definitions/BankCard'
responses:
'200':
description: ''
'400':
description: Invalid ID supplied
'404':
description: User not found
'405':
description: Invalid input
security:
- Bearer: []
definitions:
UserModel:
description: Application user model
type: object
properties:
id:
description: key
type: integer
email:
description: email
type: string
format: email
firstname:
description: first name
type: string
lastname:
description: last name
type: string
facebookId:
description: facebook id
type: string
facebookName:
description: facebook name
type: string
telegramId:
description: telegram id
type: string
telegramUserName:
description: telegram user name
type: string
slackMemberId:
description: slack member id
type: string
lineUserId:
description: line User Id
type: string
balance:
description: user balance
type: number
AccountOperation:
description: User's account operation
type: object
properties:
id:
description: key
type: integer
User:
$ref: '#/definitions/UserModel'
Amount:
description: ''
type: number
format: ''
DateTime:
description: Operation date & time
type: string
format: date-time
Comment:
description: Comment
type: string
File:
description: File object
type: object
properties:
Created:
description: File creation date & time
type: string
format: date-time
Status:
description: File status
type: integer
enum:
- Unconfirmed
- Payed
- StoredInBlockchain
- StoredInCloud
- Deleted
Source:
description: File source
type: integer
enum:
- Mail
- FacebookBot
- WebSite
- TelegramBot
- SlackBot
- LineBot
- Mobile
Size:
description: File size
type: integer
Hash:
description: File hash
type: array
items:
type: string
format: byte
User:
$ref: '#/definitions/UserModel'
Confirmed:
description: File confirmation date & time
type: string
format: date-time
Nonce:
description: File nonce
type: array
items:
type: string
format: byte
Transaction:
description: ''
type: string
maxLength: 512
CilTransaction:
description: ''
type: string
maxLength: 512
ConversationMembers:
description: ''
type: string
maxLength: 2048
ConfirmationToken:
description: Confirmation Token
type: array
items:
type: string
format: byte
InitialFee:
description: Initial fee
type: number
format: decimal
ArchivedFiles:
description: File names in arcive separated by a semicolon
type: string
FileOperation:
description: User's file operation --
type: object
BankCard:
description: Bank card --
type: object
TokenRequest:
description: Single-use token for various operations.
type: object
properties:
tokenHex:
description: Token value in HEX format.
type: string
UserCredentialsRequest:
description: User Credentials Data
type: object
required:
- login
- password
properties:
login:
description: login
type: string
password:
description: password
type: string
format: password
ProfileModel:
description: User Profile Model -- will be removed!
type: object
properties:
email:
description: Email address
type: string
format: email
firstName:
description: User's first name.
type: string
lastName:
description: User's last name.
type: string
LoginResponse:
description: Response of login method
type: object
properties:
SessionId:
description: Session Id
type: string
Email:
description: User email
type: string
format: email