documentation

This commit is contained in:
Jörn-Michael Miehe 2022-09-09 02:23:48 +00:00
parent a8c5180027
commit 564bac8ea4
2 changed files with 6 additions and 11 deletions

View file

@ -5,8 +5,6 @@ Router "text" provides:
- finding text files by name prefix - finding text files by name prefix
- getting text file raw content by name prefix - getting text file raw content by name prefix
- getting text file HTML content by name prefix (using Markdown) - getting text file HTML content by name prefix (using Markdown)
- getting the "ticker" raw content
- getting the "ticker" HTML content (using Markdown)
""" """
import re import re

View file

@ -1,12 +1,9 @@
""" """
Router "text" provides: Router "ticker" provides:
- listing text files - getting the ticker's raw content
- finding text files by name prefix - getting the ticker's HTML content (using Markdown)
- getting text file raw content by name prefix - getting the ticker's UI config
- getting text file HTML content by name prefix (using Markdown)
- getting the "ticker" raw content
- getting the "ticker" HTML content (using Markdown)
""" """
from logging import getLogger from logging import getLogger
@ -70,14 +67,14 @@ async def get_ticker_content(
return ticker_content.strip() return ticker_content.strip()
@ router.get("/get/html") @ router.get("/html")
async def get_ticker( async def get_ticker(
ticker_content: str = Depends(get_ticker_content), ticker_content: str = Depends(get_ticker_content),
) -> str: ) -> str:
return markdown(ticker_content) return markdown(ticker_content)
@ router.get("/get/raw") @ router.get("/raw")
async def get_raw_ticker( async def get_raw_ticker(
ticker_content: str = Depends(get_ticker_content), ticker_content: str = Depends(get_ticker_content),
) -> str: ) -> str: