documentation

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

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: