FlexMeasures / flexmeasures / 35706097596

86%

push

github

Serve the endpoints supporting the UI under /api/ui, instead of /api/dev (#2578)

* Serve the endpoints supporting the UI under /api/ui, instead of /api/dev

The dev blueprint was never under development: it holds the chart endpoints of FlexMeasures' own UI.
Those now live in flexmeasures.api.ui, under /api/ui, and the UI calls them there.
The /api/dev routes keep working, on the off chance that something outside FlexMeasures calls them, until FlexMeasures v2.
The docs page now says these endpoints are not meant for external UIs.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0129WrXeJ5gia2pctFH93BqC
Signed-off-by: F.N. Claessen <claessen@seita.nl>

* Add a changelog entry

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0129WrXeJ5gia2pctFH93BqC
Signed-off-by: F.N. Claessen <claessen@seita.nl>

* Embed an asset chart from the official API in the tutorial on building custom UIs

The tutorial embedded a sensor chart from the endpoints supporting the UI, which are not meant for external UIs.
It now embeds the toy building's chart from GET /api/v3_0/assets/<id>/chart, which shows the graphs set up for the asset.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0129WrXeJ5gia2pctFH93BqC
Signed-off-by: F.N. Claessen <claessen@seita.nl>

* Revert the tutorial's switch to the asset chart endpoint

This reverts commit 99aefcd33, to keep this PR to the move of the blueprint:
the tutorial keeps embedding a sensor chart, as the annotations page shows one too, and needs no new screenshot.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0129WrXeJ5gia2pctFH93BqC
Signed-off-by: F.N. Claessen <claessen@seita.nl>

* Leave the endpoints supporting the UI out of the OpenAPI specs, and name the path of their chart attributes

The specs describe the official API,... (continued)

14 of 15 new or added lines in 4 files covered. (93.33%)

19530 of 22762 relevant lines covered (85.8%)

0.86 hits per line