From 3e0a386674032714c33666dca3f96616f3c44790 Mon Sep 17 00:00:00 2001 From: Rachel Tipton Date: Mon, 27 Nov 2023 12:52:51 +0100 Subject: [PATCH] add links for swagger UI and docs --- pv_site_api/main.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pv_site_api/main.py b/pv_site_api/main.py index 5750b51..2768fba 100644 --- a/pv_site_api/main.py +++ b/pv_site_api/main.py @@ -97,7 +97,11 @@ def is_fake(): folder = os.path.dirname(os.path.abspath(__file__)) description = """ -Description of PV Site API +The Quartz Solar PV Site API generates site-specific pv forecasts for users. + +This API is built with [FastAPI](https://fastapi.tiangolo.com/), offering +users the options to both try API routes with the [`/swagger`](/swagger) UI +and read documentation with the sleek Redocs layout at [`/docs`](/docs). """ origins = os.getenv("ORIGINS", "*").split(",") @@ -581,7 +585,7 @@ def custom_openapi(): version=pv_site_api.__version__, description=description, contact={ - "name": "Nowcasting by Open Climate Fix", + "name": "Quartz Solar by Open Climate Fix", "url": "https://quartz.solar", "email": "info@openclimatefix.org", },