FlexMeasures / flexmeasures / 17606272955

74%

Build Type

push

github

Committed by web-flow

Commit Message

New-style endpoints for sensor data, deprecating older ones (#1592)

* first tech spike on putting sensor Id in the URL, merging into JSON for schema

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* let tests use the new-style endpoints

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* Also make post sensor endpoints work with new style (sensor ID in URL). Retain one test run per deprecated endpoint, too.

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* refactor and rename the args/schema tools we are using, as they are actually not generic, but only for specific schemas. Also move to a more fitting place.

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* Remove explanation of entity addresses from docs, as users don't need to know about them anymore

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* Add changelog for API

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* adapt endpoint URLs in documentation, get rid of documentation for features not being planned anytime soon

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* do not show entity addresses in sensor listing, or mention in the CLI

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* remove 2 unused vars

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* move the 2 deprecated API endpoints into a separate module, which helps dlarity in the code, but also helps so they can be left out of the API documentation.

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* docs: fix broken links

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* keep USEF whitepaper footnote

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* lower logging level for reporting usage of deprecated endpoint

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* clean out usage of unused test function parameter (sensor_name)

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* prefer to have the id only as part of the path

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* be clearer why we retu... (continued)

Run Details

1237 of 1842 branches covered (67.16%)

Branch coverage included in aggregate %.

74 of 75 new or added lines in 6 files covered. (98.67%)

2 existing lines in 2 files now uncovered.

9021 of 12275 relevant lines covered (73.49%)

5.88 hits per line