search

openclimatefix / pv-site-api

Site specific API for PV forecasting
5 stars 8 forks source link

Improve /pv_forecast documentation in API docs #142

Closed zakwatts closed 4 months ago

zakwatts commented 4 months ago

  1. The /sites/{site_uuid}/pv_forecast documentation is not reflective of what is actually pulled. (currently says 8-hours and every 30 mins when it is actually 36 hours and every 15 mins)

  2. Also the example site_uuid of 567 does not work and as such does not return a sample forecast with the error:

"Failed to retrieve PV forecast data for site 567. Status code: 500
Response: Internal Server Error"
  1. How to use /site/pv_forecast is not clear. An example of how to input multiple sites should be given.
zakwatts commented 4 months ago
  1. is done by @peterdudfield
peterdudfield commented 4 months ago

Im dont think I've done 1

zakwatts commented 4 months ago

Sorry, my mistake.

zakwatts commented 4 months ago
  1. make it clear that the expected_generation_kw is this a spot value and the datetime value is the forecast power at that exact time.
peterdudfield commented 4 months ago
  1. make it clear that the expected_generation_kw is this a spot value and the datetime value is the forecast power at that exact time.

I think its actually the average power from that time to + 15 minutes. But yes we should make it clear

peterdudfield commented 4 months ago

147 I think covers 1, 2, and 3

peterdudfield commented 4 months ago

I've put this on dev so its easier to review @zakwatts, hopefully it moves the documentation in the right direction. @rachel-labri-tipton FYI