-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #130 from openclimatefix/issue/add-swagger-informa…
…tion-to-docs add links for swagger UI and docs to API docs
- Loading branch information
Showing
1 changed file
with
8 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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(",") | ||
|
@@ -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]", | ||
}, | ||
|