Skip to content

Commit

Permalink
warn admins in docstring of consequences when descriptive data for se…
Browse files Browse the repository at this point in the history
…nsor changes with existing belief data

Signed-off-by: Nicolas Höning <nicolas@seita.nl>
  • Loading branch information
nhoening committed Aug 7, 2023
1 parent c2cb648 commit def613c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions flexmeasures/api/v3_0/sensors.py
Original file line number Diff line number Diff line change
Expand Up @@ -604,15 +604,16 @@ def patch(self, sensor_data: dict, id: int, sensor: Sensor):
.. :quickref: Sensor; Update a sensor
This endpoint sets data for an existing sensor.
Any subset of sensor fields can be sent.
Only admin users have rights to update the sensor fields.
This endpoint updates the descriptive data of an existing sensor.
The following fields are not allowed to be updated:
Any subset of sensor fields can be sent.
However, the following fields are not allowed to be updated:
- id
- generic_asset_id
- entity_address
Only admin users have rights to update the sensor fields. Be aware that changing unit, event resolution and knowledge horizon should currently only be done on sensors without existing belief data (to avoid a serious mismatch), or if you really know what you are doing.
**Example request**
.. sourcecode:: json
Expand Down

0 comments on commit def613c

Please sign in to comment.