-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
569 lines (568 loc) · 21.8 KB
/
openapi.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
564
565
566
567
568
569
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: ""
version: 0.0.1
paths:
/v1/portfolios:
get:
tags:
- PortfolioService
operationId: PortfolioService_ListPortfolios
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListPortfoliosResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- PortfolioService
operationId: PortfolioService_CreatePortfolio
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Portfolio'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Portfolio'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/portfolios/{name}:
get:
tags:
- PortfolioService
operationId: PortfolioService_GetPortfolio
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Portfolio'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/portfolios/{portfolioName}/snapshot:
get:
tags:
- PortfolioService
operationId: PortfolioService_GetPortfolioSnapshot
parameters:
- name: portfolioName
in: path
description: |-
PortfolioName is the name / identifier of the portfolio we want to
"snapshot".
required: true
schema:
type: string
- name: time
in: query
description: Time is the point in time of the requested snapshot.
schema:
type: string
format: date-time
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioSnapshot'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/portfolios/{portfolioName}/transactions:
get:
tags:
- PortfolioService
operationId: PortfolioService_ListPortfolioTransactions
parameters:
- name: portfolioName
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListPortfolioTransactionsResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/portfolios/{transaction.portfolio_name}/transactions:
post:
tags:
- PortfolioService
operationId: PortfolioService_CreatePortfolioTransaction
parameters:
- name: transaction.portfolio_name
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioEvent'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioEvent'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/securities:
get:
tags:
- SecuritiesService
operationId: SecuritiesService_ListSecurities
parameters:
- name: filter.securityNames
in: query
schema:
type: array
items:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListSecuritiesResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/securities/{name}:
get:
tags:
- SecuritiesService
operationId: SecuritiesService_GetSecurity
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Security'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/transactions/{name}:
get:
tags:
- PortfolioService
operationId: PortfolioService_GetPortfolioTransaction
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioEvent'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/transactions/{transaction.name}:
put:
tags:
- PortfolioService
operationId: PortfolioService_UpdatePortfolioTransaction
parameters:
- name: transaction.name
in: path
required: true
schema:
type: string
- name: updateMask
in: query
schema:
type: string
format: field-mask
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioEvent'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioEvent'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
Currency:
required:
- value
- symbol
type: object
properties:
value:
type: integer
format: int32
symbol:
type: string
description: |-
Currency is a currency value in the lowest unit of the selected currency
(e.g., cents for EUR/USD).
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
ListPortfolioTransactionsResponse:
required:
- transactions
type: object
properties:
transactions:
type: array
items:
$ref: '#/components/schemas/PortfolioEvent'
ListPortfoliosResponse:
required:
- portfolios
type: object
properties:
portfolios:
type: array
items:
$ref: '#/components/schemas/Portfolio'
ListSecuritiesResponse:
required:
- securities
type: object
properties:
securities:
type: array
items:
$ref: '#/components/schemas/Security'
ListedSecurity:
required:
- securityName
- ticker
- currency
type: object
properties:
securityName:
type: string
ticker:
type: string
currency:
type: string
latestQuote:
$ref: '#/components/schemas/Currency'
latestQuoteTimestamp:
type: string
format: date-time
Portfolio:
required:
- name
- displayName
- bankAccountName
type: object
properties:
name:
type: string
displayName:
type: string
bankAccountName:
type: string
description: |-
BankAccountName contains the name/identifier of the underlying bank
account.
events:
type: array
items:
$ref: '#/components/schemas/PortfolioEvent'
description: |-
Events contains all portfolio events, such as buy/sell transactions,
dividends or other. They need to be ordered by time (ascending).
PortfolioEvent:
required:
- name
- type
- time
- portfolioName
- securityName
- amount
- price
- fees
- taxes
type: object
properties:
name:
type: string
type:
enum:
- PORTFOLIO_EVENT_TYPE_UNSPECIFIED
- PORTFOLIO_EVENT_TYPE_BUY
- PORTFOLIO_EVENT_TYPE_SELL
- PORTFOLIO_EVENT_TYPE_DELIVERY_INBOUND
- PORTFOLIO_EVENT_TYPE_DELIVERY_OUTBOUND
- PORTFOLIO_EVENT_TYPE_DIVIDEND
- PORTFOLIO_EVENT_TYPE_INTEREST
- PORTFOLIO_EVENT_TYPE_DEPOSIT_CASH
- PORTFOLIO_EVENT_TYPE_WITHDRAW_CASH
- PORTFOLIO_EVENT_TYPE_ACCOUNT_FEES
- PORTFOLIO_EVENT_TYPE_TAX_REFUND
type: string
format: enum
time:
type: string
format: date-time
portfolioName:
type: string
securityName:
type: string
amount:
type: number
format: double
price:
$ref: '#/components/schemas/Currency'
fees:
$ref: '#/components/schemas/Currency'
taxes:
$ref: '#/components/schemas/Currency'
PortfolioPosition:
required:
- security
- amount
- purchaseValue
- purchasePrice
- marketValue
- marketPrice
- totalFees
- profitOrLoss
- gains
type: object
properties:
security:
$ref: '#/components/schemas/Security'
amount:
type: number
format: double
purchaseValue:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
PurchaseValue was the market value of this position when it was bought
(net; exclusive of any fees).
purchasePrice:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
PurchasePrice was the market price of this position when it was bought
(net; exclusive of any fees).
marketValue:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
MarketValue is the current market value of this position, as retrieved from
the securities service.
marketPrice:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
MarketPrice is the current market price of this position, as retrieved from
the securities service.
totalFees:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
TotalFees is the total amount of fees accumulating in this position through
various transactions.
profitOrLoss:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
ProfitOrLoss contains the absolute amount of profit or loss in this
position.
gains:
type: number
description: Gains contains the relative amount of profit or loss in this position.
format: double
PortfolioSnapshot:
required:
- time
- positions
- firstTransactionTime
- totalPurchaseValue
- totalMarketValue
- totalProfitOrLoss
- totalGains
- cash
- totalPortfolioValue
type: object
properties:
time:
type: string
description: Time is the time when this snapshot was taken.
format: date-time
positions:
type: object
additionalProperties:
$ref: '#/components/schemas/PortfolioPosition'
description: Positions holds the current positions within the snapshot and their value.
firstTransactionTime:
type: string
description: |-
FirstTransactionTime is the time of the first transaction with the
snapshot.
format: date-time
totalPurchaseValue:
allOf:
- $ref: '#/components/schemas/Currency'
description: TotalPurchaseValue contains the total purchase value of all asset positions
totalMarketValue:
allOf:
- $ref: '#/components/schemas/Currency'
description: TotalMarketValue contains the total market value of all asset positions
totalProfitOrLoss:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
TotalProfitOrLoss contains the total absolute amount of profit or loss in
this snapshot, based on asset value.
totalGains:
type: number
description: |-
TotalGains contains the total relative amount of profit or loss in this
snapshot, based on asset value.
format: double
cash:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
Cash contains the current amount of cash in the portfolio's bank
account(s).
totalPortfolioValue:
allOf:
- $ref: '#/components/schemas/Currency'
description: |-
TotalPortfolioValue contains the amount of cash plus the total market value
of all assets.
description: |-
PortfolioSnapshot represents a snapshot in time of the portfolio. It can for
example be the current state of the portfolio but also represent the state of
the portfolio at a certain time in the past.
Security:
required:
- name
- displayName
- listedOn
- quoteProvider
type: object
properties:
name:
type: string
description: |-
Name contains the unique resource name. For a stock or bond, this should be
an ISIN.
displayName:
type: string
description: DisplayName contains the human readable name.
listedOn:
type: array
items:
$ref: '#/components/schemas/ListedSecurity'
quoteProvider:
type: string
Status:
type: object
properties:
code:
type: integer
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
tags:
- name: PortfolioService
- name: SecuritiesService