Skip to content

Commit

Permalink
Merge pull request #130 from openclimatefix/issue/add-swagger-informa…
Browse files Browse the repository at this point in the history
…tion-to-docs

add links for swagger UI and docs to API docs
  • Loading branch information
rachel-labri-tipton authored Nov 27, 2023
2 parents 96c09ca + 1980020 commit ef329a3
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions pv_site_api/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,13 @@ 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`](https://api-site.quartz.solar/swagger) UI
and read the [`/docs`](https://api-site.quartz.solar/docs) with the sleeker
Redocs layout. The information is the same in both places.
"""

origins = os.getenv("ORIGINS", "*").split(",")
Expand Down Expand Up @@ -581,7 +587,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": "[email protected]",
},
Expand Down

0 comments on commit ef329a3

Please sign in to comment.