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

Feedback: Return plevels when querying GSP endpoint #305

Open
JamieTaylor-TUOS opened this issue Oct 6, 2023 · 0 comments
Open

Feedback: Return plevels when querying GSP endpoint #305

JamieTaylor-TUOS opened this issue Oct 6, 2023 · 0 comments

Comments

@JamieTaylor-TUOS
Copy link

When querying the GSP endpoint (/v0/solar/GB/gsp/{gsp_id}/forecast), optionally return the plevels as per national endpoint (/v0/solar/GB/national/forecast)

It's useful (less complex) to be able to access both GSP and national forecasts via a single endpoint. Atm if one does this using the GSP endpoint (setting gsp_id to 0 for national), it is not possible to retrieve the plevels (~error bars) associated with the national forecast.

The GSP forecasts do not (yet) compute plevels, so they would return an empty dict for the plevels key within forecastValues.

To avoid returning additional data unnecessarily and to avoid breaking any existing interfaces with the GSP endpoint, could add a new REST param to the GSP endpoint to tell the API to return the plevels: include_plevels?

Ultimately, it would be nice to get consistency between all endpoints in terms of REST params, e.g. so that calling:

/v0/solar/GB/national/forecast?include_metadata=false&start_datetime_utc=2023-10-06T00:30:00&end_datetime_utc=2023-10-06T00:30:00&creation_limit_utc=2023-10-05T07:00:00

yields an identical response to

/v0/solar/GB/gsp/0/forecast?include_metadata=false&start_datetime_utc=2023-10-06T00:30:00&end_datetime_utc=2023-10-06T00:30:00&creation_limit_utc=2023-10-05T07:00:00

@JamieTaylor-TUOS JamieTaylor-TUOS added the enhancement New feature or request label Oct 6, 2023
@peterdudfield peterdudfield changed the title Return plevels when querying GSP endpoint Feedback: Return plevels when querying GSP endpoint Mar 13, 2024
@peterdudfield peterdudfield removed the enhancement New feature or request label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants