From 7e6ba635848860251e3a570ca6a0504cd7cc1a63 Mon Sep 17 00:00:00 2001 From: braddf Date: Wed, 1 Apr 2026 15:51:02 +0100 Subject: [PATCH] docs(national): add include_metadata param to docblock --- .../internal/service/uk_national/national_router.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/quartz_api/internal/service/uk_national/national_router.py b/src/quartz_api/internal/service/uk_national/national_router.py index 78ae3f3..5643b38 100644 --- a/src/quartz_api/internal/service/uk_national/national_router.py +++ b/src/quartz_api/internal/service/uk_national/national_router.py @@ -114,10 +114,12 @@ async def get_national_forecast( 10am today is the 4-hour forecast for 10am. #### Parameters - - **forecast_horizon_minutes**: optional forecast horizon in minutes (ex. - 60 returns the forecast made an hour before the target time) + - **include_metadata**: if true, returns a NationalForecast object with + metadata about the forecast, including model name and creation datetime. - **start_datetime_utc**: optional start datetime for the query. - **end_datetime_utc**: optional end datetime for the query. + - **forecast_horizon_minutes**: optional forecast horizon in minutes (ex. + 60 returns the forecast made an hour before the target time) - **creation_limit_utc**: optional, only return forecasts made before this datetime. Note you can only go 7 days back at the moment - **model_name**: optional, specify which model to use for the forecast.