Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue 2 retire rolling parameter in api decorator (#41)
This PR updates API endpoints for POSTing data (meter data, prognoses, prices and weather data). Specifically, we: - introduce the optional "prior" parameter for POST endpoints (we already had it for GET endpoints) - deprecate the use of ISO 8601 repeating time intervals to denote rolling horizons - switch to denoting rolling horizons with regular ISO 8601 durations (a breaking API change) * Get rid of FutureWarning. * Allow prior field in postPriceDataRequest. * Clean up inferred belief times using the new prior field for POST requests. * Update documentation. * Update docstring of postPriceData. * Deprecate horizon inference for API versions 1.x. * Typo. * Add missing documentation on REST endpoints for users. Change GET to PATCH in service listing for the password-reset endpoint. * Reformulate sentences. * Refactor test message for posting price data. Finish its docstring parameters. * Add todo. * Black. * Improve error message for ChartRequestSchema param show_individual_traces_for. * Refactor already triplicate code. * Refactor code interpreting horizon and prior. * Allow prior field in postWeatherDataRequest. * Move postPrognosis endpoint forward to later versions * Consistent coding * Update years in example * Add type annotation * Refactor and remove obsolete test util * Generalize test util for verifying sensor data in db * Fix use of id attribute * Allow prior field in postPrognosisRequest * Add type annotations for API responses * Add test for postPrognosis * Adjust the simulations docs according to the use of the prior field * Synchronise terminology: change parameter to field * Add prior field in postMeterDataRequest * Simplify determine_belief_horizons * Rename and clarify * Clarify rule for resolving case in which horizon and prior are both set * Refactor determine_belief_timing * Update date in change_log.rst * Entries in main changelog.rst Co-authored-by: F.N. Claessen <felix@seita.nl>
- Loading branch information
Showing
22 changed files
with
1,182 additions
and
240 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.