FlexMeasures / flexmeasures

The intelligent & developer-friendly EMS to support real-time energy flexibility apps, rapidly and scalable.
https://flexmeasures.io
Apache License 2.0
145 stars 36 forks source link

Document fallback schedule mechanism #858

Open victorgarcia98 opened 1 year ago

victorgarcia98 commented 1 year ago

PR https://github.com/FlexMeasures/flexmeasures/pull/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 commented 1 year ago

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 commented 1 year ago

Inspiration for possible code snippets: