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. Fixes eclipse-cdt-cloud#96 Signed-off-by: Bernd Hufmann <[email protected]>
bhufmann · Nov 2, 2023 · 458f8d6 · 458f8d6
1 parent 6c4eb62
commit 458f8d6
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/API-proposed.yaml b/API-proposed.yaml
@@ -1169,6 +1169,33 @@ paths:
  application/json:
  schema:
  type: string
+ /experiments/{expUUID}:close:
+ put:
+ tags:
+ - Experiments
+ summary: Close experiment to dispose allocated resources.
+ operationId: closeExperiment
+ parameters:
+ - name: expUUID
+ in: path
+ description: UUID of the experiment to query
+ required: true
+ schema:
+ type: string
+ format: uuid
+ responses:
+ "200":
+ description: Return the model of the closed experiment
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Experiment'
+ "404":
+ description: No such experiment
+ content:
+ application/json:
+ schema:
+ type: string
  /experiments/{expUUID}:
  get:
  tags:

diff --git a/API.yaml b/API.yaml
@@ -1159,6 +1159,33 @@ paths:
  application/json:
  schema:
  type: string
+ /experiments/{expUUID}:close:
+ put:
+ tags:
+ - Experiments
+ summary: Close experiment to dispose allocated resources.
+ operationId: closeExperiment
+ parameters:
+ - name: expUUID
+ in: path
+ description: UUID of the experiment to query
+ required: true
+ schema:
+ type: string
+ format: uuid
+ responses:
+ "200":
+ description: Return the model of the closed experiment
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Experiment'
+ "404":
+ description: No such experiment
+ content:
+ application/json:
+ schema:
+ type: string
  /experiments/{expUUID}:
  get:
  tags: