From 98649dfda5ba48f59a8744114ec2224c9a893134 Mon Sep 17 00:00:00 2001
From: pcain-usgs <pcain@usgs.gov>
Date: Tue, 13 Jul 2021 12:02:05 -0600
Subject: [PATCH] update data web service documentation
---
geomagio/api/ws/app.py | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/geomagio/api/ws/app.py b/geomagio/api/ws/app.py
index 454c918ee..e965f524c 100644
--- a/geomagio/api/ws/app.py
+++ b/geomagio/api/ws/app.py
@@ -22,7 +22,13 @@ METADATA_ENDPOINT = bool(os.getenv("METADATA_ENDPOINT", False))
VERSION = os.getenv("GEOMAG_VERSION", "version")
-app = FastAPI(docs_url="/docs", root_path="/ws")
+app = FastAPI(
+ title="Geomagnetism Data Web Service",
+ description="Web service for data access and observatory/element information\n\n"
+ + "Supports realtime processing via algorithms",
+ docs_url="/docs",
+ root_path="/ws",
+)
app.include_router(algorithms.router)
app.include_router(data.router)
--
GitLab