Add functions for update of description (#20)

* Add functions for update of description

* Apply suggestions from code review

Co-authored-by: Moritz Zeumer <25636783+NXXR@users.noreply.github.com>

* change endpoint name to avoid overlap

---------

Co-authored-by: Moritz Zeumer <25636783+NXXR@users.noreply.github.com>
Co-authored-by: Zeumer, Moritz <moritz.zeumer@dlr.de>

Author: MaxBetzDLR

api/src/api/app/apis/scenarios_api.py

@@ -127,6 +127,21 @@ async def import_scenario_data(
     log.info(f'PUT /scenarios/{scenarioId} received...')
     return await controller.import_scenario_data(scenarioId, file)
 
+@router.put(
+    "/scenarios/{scenarioId}/description",
+    responses={
+        200: {"model": ReducedScenario, "description": "Updated description of scenario."},
+    },
+    tags=["Scenarios"],
+    response_model_by_alias=True,
+)
+async def update_scenario_description(
+    scenarioId: StrictStr = Path(..., description="UUID of the scenario"),
+    description: StrictStr  = Body(..., description="New description for the scenario")
+) -> ReducedScenario:
+    """Update description of a scenario."""
+    log.info(f'PUT /scenarios/{scenarioId} received...')
+    return await controller.update_scenario_description(scenarioId, description)
 
 @router.get(
     "/scenarios",

api/src/api/app/controller/scenario_controller.py

@@ -40,7 +40,8 @@
     group_get_all,
     compartment_get_all,
     node_get_by_list,
-    datapoint_update_all_by_scenario
+    datapoint_update_all_by_scenario,
+    scenario_update_description
 )
 
 class LookupObject:
@@ -283,4 +284,12 @@ async def _read_percentiles(
                                 percentile=percentile,
                                 value=value
                             ))
-        return datapoints
+        return datapoints
+    
+    async def update_scenario_description(
+        self,
+        scenarioId: StrictStr,
+        description: StrictStr,
+    ) -> ReducedScenario:
+        """Update description of a scenario."""
+        return scenario_update_description(scenarioId, description)

api/src/api/app/db/tasks.py

@@ -661,3 +661,29 @@ def datapoint_update_all_by_scenario(
         session.add(scenario)
         session.commit()
     return
+
+
+def scenario_update_description(
+    scenarioId: StrictStr,
+    description: StrictStr
+) -> ID:
+    query = select(db.Scenario).where(db.Scenario.id == scenarioId)
+    with next(get_session()) as session:
+        scenario: db.Scenario = session.exec(query).one_or_none()
+        if not scenario:
+            raise HTTPException(status_code=404, detail='A scenario with this ID does not exist')
+
+        scenario.description = description
+        session.add(scenario)
+        session.commit()
+        session.refresh(scenario)
+    return ReducedScenario(
+        id=str(scenario.id),
+        name=scenario.name,
+        description=scenario.description,
+        startDate=scenario.startDate,
+        endDate=scenario.endDate,
+        percentiles=[int(perc) for perc in scenario.percentiles.split(',')],
+        timestampSubmitted=scenario.timestampSubmitted,
+        timestampSimulated=scenario.timestampSimulated,
+    )