stream-services/api/stream-portfolio/openapi.yaml at master · piotr-backbase/stream-services · 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
openapi: 3.0.1
info:
  title: Portfolio Ingestion API
  description: Ingestion Saga for Portfolio
  version: 0.0.1
  x-logo:
    url: "https://www.backbase.com/wp-content/uploads/2017/04/backbase-logo-png.png"
    backgroundColor: "#FFFFFF"
    altText: "Backbase logo"
servers:
  - url: https://portfolio-http.proto.backbasecloud.com/
    description: The server
tags:
- name: portfolios
paths:
  ###############################################
  ## Portfolio
  ###############################################
  /portfolios:
    post:
      tags:
        - portfolio
      summary: Create Wealth of Portfolios
      operationId: createPortfolioBundlee
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WealthBundle'
      responses:
        200:
          description: The created legal entity and all their objects with internal ids
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WealthBundle'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

components:
  schemas:
    RegionBundle:
      type: object
      properties:
        region:
          $ref: schemas/v1/region.yaml
        countries:
          type: array
          items:
            $ref: schemas/v1/country.yaml
    AssetClassBundle:
      type: object
      properties:
        assetClass:
          $ref: schemas/v1/asset-class.yaml
        subAssetClasses:
          type: array
          items:
            $ref: schemas/v1/sub-asset-class.yaml
    InstrumentBundle:
      type: object
      properties:
        instrument:
          $ref: schemas/v1/instrument.yaml
        history-prices:
          type: array
          items:
            $ref: schemas/v1/instrument-history-price.yaml
    PortfolioBundle:
      type: object
      properties:
        portfolio:
          $ref: schemas/v1/portfolio.yaml
        subPortfolios:
          type: array
          items:
            $ref: schemas/v1/sub-portfolio.yaml
        allocations:
          type: array
          items:
            $ref: schemas/v1/allocation.yaml
        hierarchies:
          type: array
          items:
            $ref: schemas/v1/portfolio-positions-hierarchy.yaml
        cumulative-performances:
          type: array
          items:
            $ref: schemas/v1/portfolio-cumulative-performances.yaml
        benchmark:
          $ref: schemas/v1/portfolio-benchmark.yaml
        valuations:
          type: array
          items:
            $ref: schemas/v1/portfolio-valuation.yaml
    PositionBundle:
      type: object
      properties:
        portfolioId:
          type: string
          description: Unique identificator for a portfolio (Portfolio code)
        subPortfolioId:
          type: string
          description: Unique identificator for a sub-portfolio
        position:
          $ref: schemas/v1/position.yaml
        transaction-categories:
          type: array
          items:
            $ref: schemas/v1/transaction-category.yaml
        transactions:
          type: array
          items:
            $ref: schemas/v1/position-transaction.yaml
    WealthBundle:
      type: object
      properties:
        regions:
          description: Region Bundle (regions and countries)
          type: array
          items:
            $ref: '#/components/schemas/RegionBundle'
        assetClasses:
          description: Asset Class Bundle (asset and sub-asset classes)
          type: array
          items:
            $ref: '#/components/schemas/AssetClassBundle'
        instruments:
          description: Instruments and Hstory Prices
          type: array
          items:
            $ref: '#/components/schemas/InstrumentBundle'
        portfolios:
          description: Portfolios and reference objects
          type: array
          items:
            $ref: '#/components/schemas/PortfolioBundle'
        positions:
          description: Portfolio Positions and Transactions
          type: array
          items:
            $ref: '#/components/schemas/PositionBundle'
        aggregate-portfolios:
          description: Aggregate Portfolios
          type: array
          items:
            $ref: schemas/v1/aggregate-portfolio.yaml

    Error:
      type: object
      properties:
        message:
          type: string
          description: Any further information
        errors:
          type: array
          description: Detailed error information
          items:
            type: object
            properties:
              message:
                type: string
                description: Default Message. Any further information.
              key:
                type: string
                description: '{capability-name}.api.{api-key-name}. For generated
                      validation errors this is the path in the document the error resolves
                      to. e.g. object name + ''.'' + field'
              context:
                type: object
                description: Context can be anything used to construct localised messages.
                x-java-type: java.util.Map<String,String>
            description: A validation error