FlexMeasures / flexmeasures / 30252413625

83%

Build Type

push

github

Committed by web-flow

Commit Message

use the 202 status consistently in triggering endpoints  (#2224)

* use the 202 status consistently in triggering endpoints (forecasting, scheduling) and provide follow-up URLs in the response

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

* let get_schedule endpoint use status 202 as well, if jobs are not finished (just like get_forecast) - for now only use this (over the old 400 code) if API_SUNSET is being used

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

* simplify deprecation, was mostly unused

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

* chsnge 200 to 202 in some more tests

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

* job status emdpoint also gets 202 status (and 422 for failures); use camel-case - even in existing job status endpoitn fields (using the new field-deprecation logic)

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

* Put info about deprecated fields into the header; also react to some other review comments dealing with docs

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

* clarify how to signal deprecated fields in API endpoints, introducing the FlexMeasures-Deprecated-Response-Fields header

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

* some new tests still needed to assert 202 instead of 200

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

* Drop field-level deprecation headers from #2224; track field removal in API v4 discussion (#2350)

Legacy job-identifier fields (schedule, forecast, snake_case job metadata) remain purely additive within v3_0; their removal is tracked in the API v4 planning discussion (#2349).

Signed-off-by: F.N. Claessen <felix@seita.nl>

---------

Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Co-authored-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com>

Coverage Stats

32 of 35 new or added lines in 4 files covered. (91.43%)

1 existing line in 1 file now uncovered.

15993 of 19281 relevant lines covered (82.95%)

0.83 hits per line