This repository has been archived by the owner on Feb 22, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
404 lines (381 loc) · 10 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
openapi: 3.0.0
info:
version: 0.0.2
title: ANM4L API
description: ''
paths:
#####################################
## ANALYSIS ##
#####################################
/analysis:
get:
tags:
- Static Analysis
summary: Get all network models
operationId: dpsimadapter.get_all_analysis
responses:
'200':
description: OK
content:
# schema:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnalysisResponse'
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
tags:
- Static Analysis
summary: Add a new analysis
operationId: dpsimadapter.add_analysis
requestBody:
description: Analysis model to be added
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/PowerflowAnalysis'
- $ref: '#/components/schemas/OutageAnalysis'
example:
name: "theAnalysis"
type: "PowerflowAnalysis"
modelid: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisResponse'
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/analysis/{id}/results:
get:
tags:
- Static Analysis
summary: Get specific analysis results
operationId: dpsimadapter.get_analysis_results
parameters:
- name: id
description: Analysis id
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
text/plain:
schema:
description: Archive containing result and log files, e.g. CSV
type: string
format: binary
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/analysis/{id}/logs:
get:
tags:
- Static Analysis
summary: Get specific analysis logs
operationId: dpsimadapter.get_analysis_logs
parameters:
- name: id
description: Analysis id
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
text/plain:
schema:
description: Archive containing result and log files, e.g. CSV
type: string
format: binary
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/analysis/debug:
get:
tags:
- Static Analysis
summary: Get specific analysis logs
operationId: dpsimadapter.get_debug_logs
responses:
'200':
description: OK
content:
text/plain:
schema:
description: Archive containing result and log files, e.g. CSV
type: string
format: binary
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/analysis/{id}:
get:
tags:
- Static Analysis
summary: Get specific analysis status
operationId: dpsimadapter.get_analysis
parameters:
- name: id
description: Analysis id
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisResponse'
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
tags:
- Static Analysis
summary: Delete specific analysis including results
operationId: dpsimadapter.delete_analysis
parameters:
- name: id
description: Analysis id
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisResponse'
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
Model:
type: object
description: Properties of a simulation model
properties:
name:
type: string
description: Name of simulation model
profiles:
description: List of cgmes profiles in the model
type: array
items:
$ref: '#/components/schemas/CGMES_Profile'
version:
# TODO: Discuss this
description: cgmes version string. Example "cgmes_v2_4_15"
type: string
pattern: '^cgmes_v\d+_\d+(_\d+){0,1}$'
ModelReply:
allOf:
- type: object
required:
- id
- name
- profiles
- version
properties:
id:
type: integer
description: Handle to the model
- $ref: '#/components/schemas/Model'
ModelElement:
type: object
properties:
id:
type: integer
uuid:
description: CIM UUID of model element
type: string
name:
description: Name of model element
type: string
type:
description: CIM type of model element
type: string
ModelElementAttributes:
type: object
properties:
id:
type: integer
uuid:
description: CIM UUID of model element
type: string
name:
description: Name of model element
type: string
type:
description: CIM type of model element
type: string
attributes:
description: Element attributes, e.g. strings and numbers
type: object
NewModelElement:
type: object
required:
- name
- type
properties:
name:
description: Name of model element
type: string
type:
description: CIM type of model element
type: string
param:
description: Element attributes, e.g. strings and numbers
type: object
ModelElementUpdate:
type: object
properties:
name:
description: Name of model element
type: string
type:
description: CIM type of model element
type: string
param:
description: Element attributes, e.g. strings and numbers
type: object
Analysis:
type: object
required:
- name
- type
- modelid
properties:
name:
description: Name of analysis case
type: string
type:
description: Type of analysis, e.g. PowerflowAnalysis
type: string
modelid:
description: Model to consider for analysis
type: integer
discriminator:
propertyName: type
AnalysisResponse:
oneOf:
- $ref: '#/components/schemas/PowerflowAnalysis'
- $ref: '#/components/schemas/OutageAnalysis'
properties:
id:
type: integer
status:
description: Indicate if analysis is completed or not
# TODO change to better type (Bool/Enum (Pending/Running/Completed))
type: string
PowerflowAnalysis:
allOf:
- type: object
properties:
param:
description: >-
attribute map, e.g. strings and numbers to define solver
settings etc.
type: object
additionalProperties: {}
OutageAnalysis:
allOf:
- type: object
required:
- nm1List
properties:
nm1List:
description: List of N-1 components
type: array
items:
type: string
nm2List:
description: List of N-2 components
type: array
items:
type: string
param:
description: attribute map, e.g. strings and numbers
type: object
additionalProperties: {}
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
CGMES_Profile:
type: string
enum:
- EQ
- SSH
- TP
- SV
- DY
- GL
- DI
description: >
Profile names:
* `DI` - DiagramLayout
* `DY` - Dynamics
* `EQ` - Equipment
* `GL` - GeographicalLocation
* `SV` - StateVariables
* `SSH` - SteadyStateHypothesis
* `TP` - Topology
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
x-apikeyInfoFunc: cimadapter.apikey_auth
# Apply the apikey globally to all operations
# security:
# - ApiKeyAuth: [] # use the same name as under securitySchemes
servers:
- description: Example server
url: https://example.org/