fix(link): add comment attribute in link that was missing and causing…

… an 422 error (#2281)
AntaresSimulatorTeam · Jan 6, 2025 · 345b0a7 · 345b0a7
1 parent e929e3d
commit 345b0a7
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 1 deletion.
diff --git a/antarest/study/business/model/link_model.py b/antarest/study/business/model/link_model.py
@@ -148,6 +148,7 @@ class LinkBaseDTO(AntaresBaseModel):
     transmission_capacities: TransmissionCapacity = TransmissionCapacity.ENABLED
     asset_type: AssetType = AssetType.AC
     display_comments: bool = True
+    comments: str = ""
     colorr: int = Field(default=DEFAULT_COLOR, ge=0, le=255)
     colorb: int = Field(default=DEFAULT_COLOR, ge=0, le=255)
     colorg: int = Field(default=DEFAULT_COLOR, ge=0, le=255)
@@ -196,6 +197,7 @@ class LinkInternal(AntaresBaseModel):
     transmission_capacities: TransmissionCapacity = TransmissionCapacity.ENABLED
     asset_type: AssetType = AssetType.AC
     display_comments: bool = True
+    comments: str = ""
     colorr: int = Field(default=DEFAULT_COLOR, ge=0, le=255)
     colorb: int = Field(default=DEFAULT_COLOR, ge=0, le=255)
     colorg: int = Field(default=DEFAULT_COLOR, ge=0, le=255)

diff --git a/tests/integration/study_data_blueprint/test_link.py b/tests/integration/study_data_blueprint/test_link.py
@@ -29,7 +29,10 @@ def test_link_update(self, client: TestClient, user_access_token: str, study_typ
 
         area1_id = preparer.create_area(study_id, name="Area 1")["id"]
         area2_id = preparer.create_area(study_id, name="Area 2")["id"]
-        client.post(f"/v1/studies/{study_id}/links", json={"area1": area1_id, "area2": area2_id, "hurdlesCost": True})
+        client.post(
+            f"/v1/studies/{study_id}/links",
+            json={"area1": area1_id, "area2": area2_id, "hurdlesCost": True, "comments": "comment"},
+        )
         res = client.put(
             f"/v1/studies/{study_id}/links/{area1_id}/{area2_id}",
             json={"colorr": 150},
@@ -44,6 +47,7 @@ def test_link_update(self, client: TestClient, user_access_token: str, study_typ
             "colorg": 112,
             "colorr": 150,
             "displayComments": True,
+            "comments": "comment",
             "filterSynthesis": "hourly, daily, weekly, monthly, annual",
             "filterYearByYear": "hourly, daily, weekly, monthly, annual",
             "hurdlesCost": True,
@@ -83,6 +87,7 @@ def test_link_update(self, client: TestClient, user_access_token: str, study_typ
             "colorg": 112,
             "colorr": 150,
             "displayComments": True,
+            "comments": "comment",
             "filterSynthesis": "hourly, daily, weekly, monthly, annual",
             "filterYearByYear": "hourly, daily, weekly, monthly, annual",
             "hurdlesCost": False,
@@ -166,6 +171,7 @@ def test_link_820(self, client: TestClient, user_access_token: str, study_type:
             "colorg": 112,
             "colorr": 112,
             "displayComments": True,
+            "comments": "",
             "filterSynthesis": "hourly, daily, weekly, monthly, annual",
             "filterYearByYear": "hourly, daily, weekly, monthly, annual",
             "hurdlesCost": False,
@@ -189,6 +195,7 @@ def test_link_820(self, client: TestClient, user_access_token: str, study_type:
             "colorg": 170,
             "colorr": 180,
             "displayComments": True,
+            "comments": "comment",
             "filterSynthesis": "hourly, daily, weekly, monthly, annual",
             "filterYearByYear": "hourly, daily, weekly, monthly, annual",
             "hurdlesCost": False,
@@ -299,6 +306,7 @@ def test_link_820(self, client: TestClient, user_access_token: str, study_type:
             "colorg": 112,
             "colorr": 112,
             "displayComments": True,
+            "comments": "",
             "filterSynthesis": "",
             "filterYearByYear": "hourly, daily, weekly, monthly, annual",
             "hurdlesCost": False,
@@ -327,6 +335,7 @@ def test_link_820(self, client: TestClient, user_access_token: str, study_type:
             "colorg": 112,
             "colorr": 112,
             "displayComments": True,
+            "comments": "",
             "filterSynthesis": "hourly",
             "filterYearByYear": "hourly, daily, weekly, monthly, annual",
             "hurdlesCost": False,

diff --git a/tests/integration/study_data_blueprint/test_table_mode.py b/tests/integration/study_data_blueprint/test_table_mode.py
@@ -195,6 +195,7 @@ def test_lifecycle__nominal(
             "colorg",
             "colorr",
             "displayComments",
+            "comments",
             "filterSynthesis",
             "filterYearByYear",
             "hurdlesCost",
@@ -247,6 +248,7 @@ def test_lifecycle__nominal(
                 "colorg": 150,
                 "colorr": 200,
                 "displayComments": False,
+                "comments": "",
                 "hurdlesCost": True,
                 "linkStyle": "plain",
                 "linkWidth": 2,
@@ -262,6 +264,7 @@ def test_lifecycle__nominal(
                 "colorg": 112,
                 "colorb": 112,
                 "displayComments": True,
+                "comments": "",
                 "hurdlesCost": False,
                 "linkStyle": "plain",
                 "linkWidth": 1,
@@ -277,6 +280,7 @@ def test_lifecycle__nominal(
                 "colorg": 150,
                 "colorr": 200,
                 "displayComments": True,
+                "comments": "",
                 "hurdlesCost": True,
                 "linkStyle": "plain",
                 "linkWidth": 1,
@@ -292,6 +296,7 @@ def test_lifecycle__nominal(
                 "colorg": 112,
                 "colorr": 112,
                 "displayComments": True,
+                "comments": "",
                 "hurdlesCost": True,
                 "linkStyle": "plain",
                 "linkWidth": 1,

diff --git a/tests/integration/test_integration.py b/tests/integration/test_integration.py
@@ -604,6 +604,7 @@ def test_area_management(client: TestClient, admin_access_token: str) -> None:
             "colorg": 112,
             "colorr": 112,
             "displayComments": True,
+            "comments": "",
             "filterSynthesis": "hourly, daily, weekly, monthly, annual",
             "filterYearByYear": "hourly, daily, weekly, monthly, annual",
             "hurdlesCost": False,

diff --git a/tests/storage/business/test_arealink_manager.py b/tests/storage/business/test_arealink_manager.py
@@ -247,6 +247,7 @@ def test_area_crud(empty_study: FileStudy, matrix_service: SimpleMatrixService):
                         "transmission_capacities": TransmissionCapacity.ENABLED,
                         "asset_type": AssetType.AC,
                         "display_comments": True,
+                        "comments": "",
                         "colorr": 112,
                         "colorg": 112,
                         "colorb": 112,
@@ -287,6 +288,7 @@ def test_area_crud(empty_study: FileStudy, matrix_service: SimpleMatrixService):
                         "transmission_capacities": TransmissionCapacity.ENABLED,
                         "asset_type": AssetType.AC,
                         "display_comments": True,
+                        "comments": "",
                         "colorr": 112,
                         "colorg": 112,
                         "colorb": 112,
@@ -543,6 +545,7 @@ def test_get_all_area():
             "colorg": 112,
             "colorr": 112,
             "display_comments": False,
+            "comments": "",
             "filter_synthesis": "hourly, daily, weekly, monthly, annual",
             "filter_year_by_year": "hourly, daily, weekly, monthly, annual",
             "hurdles_cost": False,
@@ -560,6 +563,7 @@ def test_get_all_area():
             "colorg": 112,
             "colorr": 112,
             "display_comments": False,
+            "comments": "",
             "filter_synthesis": "hourly, daily, weekly, monthly, annual",
             "filter_year_by_year": "hourly, daily, weekly, monthly, annual",
             "hurdles_cost": False,
@@ -577,6 +581,7 @@ def test_get_all_area():
             "colorg": 112,
             "colorr": 112,
             "display_comments": False,
+            "comments": "",
             "filter_synthesis": "hourly, daily, weekly, monthly, annual",
             "filter_year_by_year": "hourly, daily, weekly, monthly, annual",
             "hurdles_cost": False,