Skip to content

docs(national): add include_metadata param to docblock #275

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.

Sign up for GitHub

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

Open
braddf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(national): add include_metadata param to docblock #275

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/quartz_api/internal/service/uk_national/national_router.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading