From 0e16ae0eaaadf485ae5d488c16d060ef7fae22de Mon Sep 17 00:00:00 2001
From: Robert Goldmann <deadlocker@gmx.de>
Date: Sat, 16 Jan 2021 17:18:53 +0100
Subject: [PATCH] fixed documentation for index and /version route
---
src/main.py | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/src/main.py b/src/main.py
index 0a98307..5732f36 100644
--- a/src/main.py
+++ b/src/main.py
@@ -23,21 +23,24 @@ app = FastAPI(title=Constants.APP_NAME,
version=VERSION['name'],
description='The StorageLeaf API',
servers=[{'url': SETTINGS['api']['url'], 'description': f'{Constants.APP_NAME} API'}])
-app.include_router(DeviceRouter.router)
-app.include_router(SensorRouter.router)
-app.include_router(MeasurementRouter.router)
-@app.get('/')
+@app.get('/', include_in_schema=False)
async def root():
return RedirectResponse(url='/docs')
-@app.get('/version')
+@app.get('/version',
+ summary='Gets information about the server version',
+ tags=['general'])
async def version():
return JSONResponse(content=VERSION)
+app.include_router(DeviceRouter.router)
+app.include_router(SensorRouter.router)
+app.include_router(MeasurementRouter.router)
+
if __name__ == '__main__':
serverSettings = SETTINGS['server']
protocol = 'https' if serverSettings['useSSL'] else 'http'
@@ -56,5 +59,3 @@ if __name__ == '__main__':
ssl_certfile=serverSettings['certfile'])
else:
uvicorn.run(app, host=serverSettings['listen'], port=serverSettings['port'])
-
-
--
GitLab