-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
410 lines (410 loc) · 12.8 KB
/
openapi.yml
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
openapi: 3.0.0
info:
title: Alerts App
description: Alerts API.
contact:
email: [email protected]
version: "0.1b"
servers:
- url: 'http://localhost:8000/v1'
tags:
- name: user
description: User endpoints
- name: oauth
description: Ouath2 endpoints
- name: alerts
description: Alerts endpoints
- name: markets
description: Markets endpoints
paths:
/signup:
post:
tags:
- user
summary: Signs up User
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: users
attributes:
type: object
properties:
email:
type: string
example: [email protected]
password:
type: string
example: password123
responses:
'202':
description: Accepted - even when users already exists.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: integer
nullable: true
example: null
'422':
description: Unprocessable Entity
content:
application/vnd.api+json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
source:
type: string
examples:
emailMissing:
value:
- code: missing
source: /data/attributes/email
emailBlank:
value:
- code: blank
source: /data/attributes/email
emailFormatInvalid:
value:
- code: formatInvalid
source: /data/attributes/email
passwordMissing:
value:
- code: missing
source: /data/attributes/password
passwordBlank:
value:
- code: blank
source: /data/attributes/password
passwordTooShort:
value:
- code: tooShort
source: /data/attributes/password
/token:
post:
tags:
- oauth
summary: Gets access token in Oauth 2.0 standard
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
grant_type:
type: string
example: password
username:
type: string
example: [email protected]
password:
type: string
example: password
refresh_token:
type: string
example: refresh_token
examples:
password:
summary: Password authentication
value:
grant_type: password
username: username123
password: password123
refresh_token:
summary: Refresh token authentication
value:
grant_type: refresh_token
refresh_token: 8a7d6adagdadhah7s6d76ad76
responses:
'200':
description: OK - access granted.
content:
application/vnd.api+json:
schema:
type: object
properties:
access_token:
type: string
example: MTQ0NjOkZmQ5OTM5NDE9ZTZjNGZmZjI3
token_type:
type: string
example: bearer
expires_in:
type: integer
example: 86400
refresh_token:
type: string
example: 8a7d6adagdadhah7s6d76ad76
'400':
description: Bad Request
content:
application/vnd.api+json:
schema:
type: object
properties:
error:
type: string
examples:
invalid_grant:
description: The authorization code is invalid or expired.
value:
error: invalid_grant
invalid_request:
description: >-
The request is missing a parameter so the server can’t
proceed with the request.
value:
error: invalid_request
unsupported_grant_type:
description: >-
Requested grant type is not recognized by the authorization
server.
value:
error: unsupported_grant_type
/me/alerts:
get:
tags:
- alerts
summary: Lists user's alerts.
responses:
'200':
description: OK - resources returned.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
uuid:
type: string
format: uuid
example: 1e9e35fb-224d-4075-9f64-fe037c7167a6
market_uuid:
type: string
format: uuid
example: 1e9e35fb-224d-4075-9f64-fe037c7167a6
user_uuid:
type: string
format: uuid
example: 1e9e35fb-224d-4075-9f64-fe037c7167a6
activation_price:
type: number
example: 1.23
trigger_price:
type: number
example: 4.56
triggered_at:
type: string
format: date-time
example: '2017-07-21T17:32:28Z'
turned_off_at:
type: string
format: date-time
example: '2017-07-21T17:32:28Z'
triggered?:
type: boolean
example: true
turned_off?:
type: boolean
example: true
'401':
description: Unauthorized.
post:
tags:
- alerts
summary: Creates a new Alert
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: alerts
attributes:
type: object
properties:
market_uuid:
type: string
example: 1e9e35fb-224d-4075-9f64-fe037c7167a6
activation_price:
type: number
example: 1.23
trigger_price:
type: number
example: 4.56
responses:
'202':
description: Accepted.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: integer
nullable: true
example: null
'401':
description: Unauthorized.
'422':
description: Unprocessable Entity
content:
application/vnd.api+json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
source:
type: string
examples:
marketUuidMissing:
value:
- code: missing
source: /data/attributes/market_uuid
marketUuidBlank:
value:
- code: blank
source: /data/attributes/market_uuid
activationPriceMissing:
value:
- code: missing
source: /data/attributes/activation_price
activationPriceLessOrEqualZero:
value:
- code: less_or_equal_zero
source: /data/attributes/activation_price
triggerPriceMissing:
value:
- code: missing
source: /data/attributes/trigger_price
triggerPriceLessOrEqualZero:
value:
- code: less_or_equal_zero
source: /data/attributes/trigger_price
'/me/alerts/{alert_uuid}/turn_off':
post:
tags:
- alerts
summary: Turns off the alert.
parameters:
- in: path
name: alert_uuid
schema:
type: string
required: true
description: UUID of the alert.
responses:
'202':
description: Accepted.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: integer
nullable: true
example: null
'401':
description: Unauthorized.
'/me/alerts/{alert_uuid}':
delete:
tags:
- alerts
summary: Delets the alert.
parameters:
- in: path
name: alert_uuid
schema:
type: string
required: true
description: UUID of the alert.
responses:
'202':
description: Accepted.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: integer
nullable: true
example: null
'401':
description: Unauthorized.\
/markets:
get:
tags:
- markets
summary: Lists all markets.
responses:
'200':
description: OK - resources returned.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
example: 1e9e35fb-224d-4075-9f64-fe037c7167a6
type:
type: string
example: markets
attributes:
type: object
properties:
platform:
type: string
example: bittrex
name:
type: string
example: LTC-BTC