Add unit query parameter to GET schedule endpoint for unit conversion

[Copilot]

The GET schedule endpoint always returned values in the sensor's native unit, making it difficult for clients that operate in different (but compatible) units.

Changes

• flexmeasures/api/v3_0/sensors.py

  • Accept optional unit query param via UnitField in get_schedule
  • Convert schedule values from sensor unit to requested unit using convert_units; return ValidationError (422) if units are incompatible
  • Updated OpenAPI spec to document the new unit parameter

• flexmeasures/api/v3_0/tests/test_sensor_schedules.py

  • Added test_get_schedule_with_unit covering: default (sensor unit), compatible unit conversion, and incompatible unit rejection

• Some schema refactoring by @Flix6x to modernize field validation.

Example

GET /api/v3_0/sensors/5/schedules/<uuid>?unit=kW

For a sensor with unit MW, this returns values scaled by 1000 and "unit": "kW" in the response. Requesting an incompatible unit like °C returns a 422.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Get schedule in any compatible unit</issue_title>
<issue_description>The endpoint for fetching a schedule for a given sensor, should accept a "unit" field, which should use our unit_utils.py to convert the schedule from the sensor unit to the desired unit.

The PR should include test coverage for the new feature. I imagine updating an existing API test suffices.

This feature will help support FlexMeasures/flexmeasures-client#67</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Get schedule in any compatible unit #1992

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[read-the-docs-community]

Documentation build overview

📚 flexmeasures | 🛠️ Build #31603630 | 📁 Comparing c362a43 against latest (7f2c631)

🔍 Preview build

Show files changed (9 files in total): 📝 9 modified | ➕ 0 added | ➖ 0 deleted

File	Status
changelog.html	📝 modified
genindex.html	📝 modified
_autosummary/flexmeasures.api.common.schemas.sensors.html	📝 modified
_autosummary/flexmeasures.api.common.utils.validators.html	📝 modified
_autosummary/flexmeasures.api.v3_0.sensors.html	📝 modified
_autosummary/flexmeasures.data.schemas.scheduling.html	📝 modified
_autosummary/flexmeasures.data.schemas.units.html	📝 modified
api/change_log.html	📝 modified
api/v3_0.html	📝 modified