From 564bac8ea4919e6d1ccdfd79f48f4ffe8b3d6266 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn-Michael=20Miehe?= <40151420+ldericher@users.noreply.github.com> Date: Fri, 9 Sep 2022 02:23:48 +0000 Subject: [PATCH] documentation --- api/ovdashboard_api/routers/text.py | 2 -- api/ovdashboard_api/routers/ticker.py | 15 ++++++--------- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/api/ovdashboard_api/routers/text.py b/api/ovdashboard_api/routers/text.py index 37b129d..efa83de 100644 --- a/api/ovdashboard_api/routers/text.py +++ b/api/ovdashboard_api/routers/text.py @@ -5,8 +5,6 @@ Router "text" provides: - finding text files by name prefix - getting text file raw content by name prefix - getting text file HTML content by name prefix (using Markdown) -- getting the "ticker" raw content -- getting the "ticker" HTML content (using Markdown) """ import re diff --git a/api/ovdashboard_api/routers/ticker.py b/api/ovdashboard_api/routers/ticker.py index 2f7d499..39932b0 100644 --- a/api/ovdashboard_api/routers/ticker.py +++ b/api/ovdashboard_api/routers/ticker.py @@ -1,12 +1,9 @@ """ -Router "text" provides: +Router "ticker" provides: -- listing text files -- finding text files by name prefix -- getting text file raw content by name prefix -- getting text file HTML content by name prefix (using Markdown) -- getting the "ticker" raw content -- getting the "ticker" HTML content (using Markdown) +- getting the ticker's raw content +- getting the ticker's HTML content (using Markdown) +- getting the ticker's UI config """ from logging import getLogger @@ -70,14 +67,14 @@ async def get_ticker_content( return ticker_content.strip() -@ router.get("/get/html") +@ router.get("/html") async def get_ticker( ticker_content: str = Depends(get_ticker_content), ) -> str: return markdown(ticker_content) -@ router.get("/get/raw") +@ router.get("/raw") async def get_raw_ticker( ticker_content: str = Depends(get_ticker_content), ) -> str: