-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
222 lines (222 loc) · 6.2 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
openapi: 3.1.0
info:
title: Correlation App API
description: API to manage and query correlations between assets.
version: 1.0.0
servers:
- url: "https://{server}/v1"
variables:
server:
default: correlation
- url: "https://{environment}.eliona.io/apps/correlation/api/v1/"
variables:
environment:
default: name
paths:
/correlate:
post:
summary: Correlate assets
description: Computes correlations between specified assets.
operationId: correlate_assets
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationRequest'
responses:
'200':
description: Successfully computed correlations.
content:
application/json:
schema:
type: object
properties:
assets:
type: array
items:
$ref: '#/components/schemas/AssetAttribute'
lags:
type: array
items:
type: object
additionalProperties:
type: integer
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
correlation:
type: object
additionalProperties:
type: number
'400':
description: Invalid request.
'500':
description: Error computing correlations.
/correlate-children:
post:
summary: Correlate asset children
description: Computes correlations between an asset and its children.
operationId: correlate_asset_children
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelateChildrenRequest'
responses:
'200':
description: Successfully computed correlations.
content:
application/json:
schema:
type: object
properties:
assets:
type: array
items:
$ref: '#/components/schemas/AssetAttribute'
lags:
type: array
items:
type: object
additionalProperties:
type: integer
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
correlation:
type: object
additionalProperties:
type: number
'400':
description: Invalid request.
'500':
description: Error computing correlations.
/in-depth-correlation:
post:
summary: In-depth correlation
description: Computes in-depth correlations between exactly two assets/attributes.
operationId: in_depth_correlation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationRequest'
responses:
'200':
description: Successfully computed in-depth correlations.
content:
application/json:
schema:
type: object
properties:
assets:
type: array
items:
$ref: '#/components/schemas/AssetAttribute'
lags:
type: array
items:
type: object
additionalProperties:
type: integer
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
correlation:
type: object
additionalProperties:
type: number
scatter_plot:
type: string
format: byte
columns:
type: array
items:
type: string
lag_plots:
type: object
additionalProperties:
type: string
format: byte
'400':
description: Invalid request.
'500':
description: Error computing in-depth correlations.
components:
schemas:
LagUnit:
type: string
enum:
- seconds
- minutes
- hours
- days
- months
- years
AssetAttribute:
type: object
properties:
asset_id:
type: integer
attribute_name:
type: string
nullable: true
required:
- asset_id
CorrelationRequest:
type: object
properties:
assets:
type: array
items:
$ref: '#/components/schemas/AssetAttribute'
lags:
type: array
items:
type: object
additionalProperties:
type: integer
start_time:
type: string
format: date-time
nullable: true
end_time:
type: string
format: date-time
nullable: true
required:
- assets
CorrelateChildrenRequest:
type: object
properties:
asset_id:
type: integer
lags:
type: array
items:
type: object
additionalProperties:
type: integer
nullable: true
start_time:
type: string
format: date-time
nullable: true
end_time:
type: string
format: date-time
nullable: true
required:
- asset_id