Skip to content

Commit c7012d2

Browse files
committed
Add an endpoint for closing an experiment
With this it's possible to close an experiment on the server. Upon reception of the command the server can dispose allocated resources hence the client doesn't need them anymore. UI clients for example can close the experiment when a user closed the graphs. Signed-off-by: Bernd Hufmann <[email protected]>
1 parent 6c4eb62 commit c7012d2

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

API-proposed.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1169,6 +1169,33 @@ paths:
11691169
application/json:
11701170
schema:
11711171
type: string
1172+
/experiments/{expUUID}:close:
1173+
put:
1174+
tags:
1175+
- Experiments
1176+
summary: Close experiment to dispose allocated resources.
1177+
operationId: closeExperiment
1178+
parameters:
1179+
- name: expUUID
1180+
in: path
1181+
description: UUID of the experiment to query
1182+
required: true
1183+
schema:
1184+
type: string
1185+
format: uuid
1186+
responses:
1187+
"200":
1188+
description: Return the model of the closed experiment
1189+
content:
1190+
application/json:
1191+
schema:
1192+
$ref: '#/components/schemas/Experiment'
1193+
"404":
1194+
description: No such experiment
1195+
content:
1196+
application/json:
1197+
schema:
1198+
type: string
11721199
/experiments/{expUUID}:
11731200
get:
11741201
tags:

API.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1159,6 +1159,33 @@ paths:
11591159
application/json:
11601160
schema:
11611161
type: string
1162+
/experiments/{expUUID}:close:
1163+
put:
1164+
tags:
1165+
- Experiments
1166+
summary: Close experiment to dispose allocated resources.
1167+
operationId: closeExperiment
1168+
parameters:
1169+
- name: expUUID
1170+
in: path
1171+
description: UUID of the experiment to query
1172+
required: true
1173+
schema:
1174+
type: string
1175+
format: uuid
1176+
responses:
1177+
"200":
1178+
description: Return the model of the closed experiment
1179+
content:
1180+
application/json:
1181+
schema:
1182+
$ref: '#/components/schemas/Experiment'
1183+
"404":
1184+
description: No such experiment
1185+
content:
1186+
application/json:
1187+
schema:
1188+
type: string
11621189
/experiments/{expUUID}:
11631190
get:
11641191
tags:

0 commit comments

Comments
 (0)