433 patch sensor

documentation/api/change_log.rst

@@ -5,6 +5,10 @@ API change log
 
 .. note:: The FlexMeasures API follows its own versioning scheme. This is also reflected in the URL, allowing developers to upgrade at their own pace.
 
+v3.0-8 | 2023-08-01
+"""""""""""""""""""
+
+- Added REST endpoint for patching a sensor: `/sensor<id>` (PATCH)
 
 v3.0-12 | 2023-07-31
 """""""""""""""""""

documentation/changelog.rst

@@ -18,7 +18,7 @@ New features
 * Users on FlexMeasures servers in play mode (``FLEXMEASURES_MODE = "play"``) can use the ``sensors_to_show`` attribute to show any sensor on their asset pages, rather than only sensors registered to assets in their own account or to public assets [see `PR #740 <https://www.github.com/FlexMeasures/flexmeasures/pull/740>`_]
 * Having percentages within the [0, 100] domain is such a common use case that we now always include it in sensor charts with % units, making it easier to read off individual charts and also to compare across charts [see `PR #739 <https://www.github.com/FlexMeasures/flexmeasures/pull/739>`_]
 * DataSource table now allows storing arbitrary attributes as a JSON (without content validation), similar to the Sensor and GenericAsset tables [see `PR #750 <https://www.github.com/FlexMeasures/flexmeasures/pull/750>`_]
-* Added API endpoints `/sensors/<id>` for fetching a single sensor and `/sensors` (POST) for adding a sensor. [see `PR #759 <https://www.github.com/FlexMeasures/flexmeasures/pull/759>`_] and [see `PR #767 <https://www.github.com/FlexMeasures/flexmeasures/pull/767>`_]
+* Added API endpoints `/sensors/<id>` for fetching a single sensor, `/sensors` (POST) for adding a sensor and `/sensor/<id>` (PATCH) for updating a sensor. [see `PR #759 <https://www.github.com/FlexMeasures/flexmeasures/pull/759>`_] and [see `PR #767 <https://www.github.com/FlexMeasures/flexmeasures/pull/767>`_] and [see `PR #773 <https://www.github.com/FlexMeasures/flexmeasures/pull/773>`_]
 * The CLI now allows to set lists and dicts as asset & sensor attributes (formerly only single values) [see `PR #762 <https://www.github.com/FlexMeasures/flexmeasures/pull/762>`_]
 * Add `ProcessScheduler` class, which optimizes the starting time of processes using one of the following policies: INFLEXIBLE, SHIFTABLE and BREAKABLE [see `PR #729 <https://www.github.com/FlexMeasures/flexmeasures/pull/729>`_]
 

flexmeasures/api/v3_0/sensors.py

@@ -48,6 +48,7 @@
 post_sensor_schema = PostSensorDataSchema()
 sensors_schema = SensorSchema(many=True)
 sensor_schema = SensorSchema()
+partial_sensor_schema = SensorSchema(partial=True, exclude=["generic_asset_id"])
 
 
 class SensorAPI(FlaskView):
@@ -576,3 +577,56 @@ def post(self, sensor_data: dict):
         db.session.add(sensor)
         db.session.commit()
         return sensor_schema.dump(sensor), 201
+
+    @route("/<id>", methods=["PATCH"])
+    @use_args(partial_sensor_schema)
+    @use_kwargs({"db_sensor": SensorIdField(data_key="id")}, location="path")
+    @permission_required_for_context("update", ctx_arg_name="db_sensor")
+    @as_json
+    def patch(self, sensor_data: dict, id: int, db_sensor: Sensor):
+        """Update an sensor given its identifier.
+
+        .. :quickref: Sensor; Update a sensor
+
+        This endpoint sets data for an existing sensor.
+        Any subset of sensor fields can be sent.
+
+        The following fields are not allowed to be updated:
+        - id
+        - generic_asset_id
+
+        **Example request**
+
+        .. sourcecode:: json
+
+            {
+                "name": "POWER",
+            }
+
+        **Example response**
+
+        The whole sensor is returned in the response:
+
+        .. sourcecode:: json
+
+            {
+                "name": "POWER",
+                "event_resolution": "PT1H",
+                "unit": "kWh",
+                "generic_asset_id": 1,
+            }
+
+        :reqheader Authorization: The authentication token
+        :reqheader Content-Type: application/json
+        :resheader Content-Type: application/json
+        :status 200: UPDATED
+        :status 400: INVALID_REQUEST, REQUIRED_INFO_MISSING, UNEXPECTED_PARAMS
+        :status 401: UNAUTHORIZED
+        :status 403: INVALID_SENDER
+        :status 422: UNPROCESSABLE_ENTITY
+        """
+        for k, v in sensor_data.items():
+            setattr(db_sensor, k, v)
+        db.session.add(db_sensor)
+        db.session.commit()
+        return sensor_schema.dump(db_sensor), 200

flexmeasures/api/v3_0/tests/test_sensors_api.py

@@ -106,3 +106,57 @@ def test_post_sensor_to_asset_from_unrelated_account(client, setup_api_test_data
         == "You cannot be authorized for this content or functionality."
     )
     assert response.json["status"] == "INVALID_SENDER"
+
+
+def test_patch_sensor(client, setup_api_test_data):
+    auth_token = get_auth_token(client, "test_admin_user@seita.nl", "testtest")
+    sensor = Sensor.query.filter(Sensor.name == "some gas sensor").one_or_none()
+
+    response = client.patch(
+        url_for("SensorAPI:patch", id=sensor.id),
+        headers={"content-type": "application/json", "Authorization": auth_token},
+        json={
+            "name": "Changed name",
+        },
+    )
+    assert response.json["name"] == "Changed name"
+    new_sensor = Sensor.query.filter(Sensor.name == "Changed name").one_or_none()
+    assert new_sensor.name == "Changed name"
+    assert Sensor.query.filter(Sensor.name == "some gas sensor").one_or_none() is None
+
+
+def test_patch_sensor_for_excluded_attribute(client, setup_api_test_data):
+    """Test to change the generic_asset_id that should not be allowed.
+    The generic_asset_id is excluded in the partial_sensor_schema"""
+    auth_token = get_auth_token(client, "test_admin_user@seita.nl", "testtest")
+    sensor = Sensor.query.filter(Sensor.name == "some temperature sensor").one_or_none()
+
+    response = client.patch(
+        url_for("SensorAPI:patch", id=sensor.id),
+        headers={"content-type": "application/json", "Authorization": auth_token},
+        json={
+            "generic_asset_id": 8,
+        },
+    )
+
+    assert response.status_code == 422
+    assert response.json["status"] == "UNPROCESSABLE_ENTITY"
+
+
+def test_patch_sensor_from_unrelated_account(client, setup_api_test_data):
+    """Try to change the name of a sensor that is in an account the user does not
+    have access to"""
+    headers = make_headers_for("test_prosumer_user_2@seita.nl", client)
+
+    sensor = Sensor.query.filter(Sensor.name == "some temperature sensor").one_or_none()
+
+    response = client.patch(
+        url_for("SensorAPI:patch", id=sensor.id),
+        headers=headers,
+        json={
+            "name": "try to change the name",
+        },
+    )
+
+    assert response.status_code == 403
+    assert response.json["status"] == "INVALID_SENDER"