Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document fallback schedule mechanism #858

Open
victorgarcia98 opened this issue Sep 20, 2023 · 2 comments
Open

Document fallback schedule mechanism #858

victorgarcia98 opened this issue Sep 20, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@victorgarcia98
Copy link
Contributor

PR #846 introduces a new way to handle fallback schedulers: schedule a fallback job on failure of the main schedule. Moreover, exposes this information via the API by returning the status code 303 on request of the original job with the location of the new resource. This behavior needs to be described in the documentation.

@Flix6x
Copy link
Contributor

Flix6x commented Nov 1, 2023

Should this become a general section in https://flexmeasures.readthedocs.io/en/latest/api/introduction.html (e.g. just before Deprecation and sunset) explaining that API endpoints may respond with a status 303 (See Other), with a short example code snippet for clients (similar to what we provide in the Deprecation and sunset section)?

@Flix6x
Copy link
Contributor

Flix6x commented Nov 1, 2023

Inspiration for possible code snippets:

@Flix6x Flix6x modified the milestones: 0.17.0, 0.18.0 Nov 7, 2023
@Flix6x Flix6x modified the milestones: 0.18.0, 0.19.0 Dec 19, 2023
@nhoening nhoening modified the milestones: 0.19.0, 0.20 Feb 18, 2024
@nhoening nhoening modified the milestones: 0.20, 0.21 Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants