Add "read-only" tag to read only endpoints

Author: mhajder

app/api/endpoints/dns.py

@@ -118,7 +118,7 @@ async def dns_add_record(data: DNSAddRecord):
         ) from exc
 
 
-@router.get("/templates", summary="List DNS templates")
+@router.get("/templates", summary="List DNS templates", tags=["read-only"])
 async def dns_templates():
     """
     List available DNS templates.
@@ -133,7 +133,7 @@ async def dns_templates():
         ) from exc
 
 
-@router.get("/list", summary="List DNS zones or records")
+@router.get("/list", summary="List DNS zones or records", tags=["read-only"])
 async def dns_list(
     dns_domain: str | None = Query(
         None,

app/api/endpoints/ftp.py

@@ -91,7 +91,7 @@ async def ftp_quota(data: FTPQuota):
         ) from exc
 
 
-@router.get("/list", summary="List FTP accounts")
+@router.get("/list", summary="List FTP accounts", tags=["read-only"])
 async def ftp_list():
     """
     List all FTP accounts.

app/api/endpoints/info.py

@@ -10,7 +10,7 @@
 router = APIRouter(prefix="/info", tags=["info"])
 
 
-@router.get("/limits", summary="Account limits")
+@router.get("/limits", summary="Account limits", tags=["read-only"])
 async def info_limits():
     """
     Return account limits information.
@@ -25,7 +25,7 @@ async def info_limits():
         ) from exc
 
 
-@router.get("/account", summary="Basic account info")
+@router.get("/account", summary="Basic account info", tags=["read-only"])
 async def info_account():
     """
     Return basic account information.

app/api/endpoints/mail.py

@@ -140,7 +140,7 @@ async def mail_quota(data: MailQuota):
         ) from exc
 
 
-@router.get("/list", summary="List mail domains or accounts")
+@router.get("/list", summary="List mail domains or accounts", tags=["read-only"])
 async def mail_list(
     email_domain: str | None = Query(
         None, description="Optional email domain to filter results"
@@ -196,7 +196,9 @@ async def mail_whitelist_del(
         ) from exc
 
 
-@router.get("/whitelist/list", summary="List mail whitelist domains")
+@router.get(
+    "/whitelist/list", summary="List mail whitelist domains", tags=["read-only"]
+)
 async def mail_whitelist_list():
     """
     List all whitelisted mail domains.
@@ -228,7 +230,7 @@ async def mail_dkim_sign(data: MailDKIM):
         ) from exc
 
 
-@router.get("/dkim/dns/{domain}", summary="Get DKIM DNS record")
+@router.get("/dkim/dns/{domain}", summary="Get DKIM DNS record", tags=["read-only"])
 async def mail_dkim_dns(
     domain: str = Path(..., description="Domain to get DKIM DNS record for"),
     print_record: bool = Query(

app/api/endpoints/mongo.py

@@ -62,7 +62,7 @@ async def mongo_passwd(data: MongoPasswd):
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.get("/list", summary="List MongoDB databases and users")
+@router.get("/list", summary="List MongoDB databases and users", tags=["read-only"])
 async def mongo_list():
     """
     List MongoDB databases and users.

app/api/endpoints/mysql.py

@@ -189,7 +189,7 @@ async def mysql_passwd(data: MySQLPasswd):
         ) from exc
 
 
-@router.get("/list", summary="List MySQL databases and users")
+@router.get("/list", summary="List MySQL databases and users", tags=["read-only"])
 async def mysql_list():
     """
     List MySQL databases and users.

app/api/endpoints/pgsql.py

@@ -81,7 +81,7 @@ async def pgsql_extensions(data: PgSQLExtension):
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.get("/list", summary="List PostgreSQL databases and users")
+@router.get("/list", summary="List PostgreSQL databases and users", tags=["read-only"])
 async def pgsql_list():
     """
     List PostgreSQL databases and users.

app/api/endpoints/port.py

@@ -56,7 +56,7 @@ async def port_del(
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.get("/list", summary="List reserved ports")
+@router.get("/list", summary="List reserved ports", tags=["read-only"])
 async def port_list():
     """
     List all reserved ports.

app/api/endpoints/repo.py

@@ -151,7 +151,7 @@ async def repo_account_passwd(data: RepoAccountPasswd):
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.get("/list", summary="List repositories or accounts")
+@router.get("/list", summary="List repositories or accounts", tags=["read-only"])
 async def repo_list(
     repo_type: RepoType | None = Query(
         None,

app/api/endpoints/ssl.py

@@ -67,7 +67,7 @@ async def ssl_www_del(
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.post("/www/get", summary="Get WWW SSL certificate")
+@router.post("/www/get", summary="Get WWW SSL certificate", tags=["read-only"])
 async def ssl_www_get(data: SSLWWWGet):
     """
     Get certificate and key for a WWW SSL entry.
@@ -84,7 +84,7 @@ async def ssl_www_get(data: SSLWWWGet):
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.get("/www/list", summary="List WWW SSL certificates")
+@router.get("/www/list", summary="List WWW SSL certificates", tags=["read-only"])
 async def ssl_www_list():
     """
     List all WWW SSL certificates.
@@ -134,7 +134,7 @@ async def ssl_mail_del(ssl_ip: str = Path(..., description="SSL IP address")):
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.post("/mail/get", summary="Get mail SSL certificate")
+@router.post("/mail/get", summary="Get mail SSL certificate", tags=["read-only"])
 async def ssl_mail_get(data: SSLMailGet):
     """
     Get certificate and key for a mail SSL entry.
@@ -148,7 +148,7 @@ async def ssl_mail_get(data: SSLMailGet):
         raise HTTPException(status_code=400, detail=str(exc)) from exc
 
 
-@router.get("/mail/list", summary="List mail SSL certificates")
+@router.get("/mail/list", summary="List mail SSL certificates", tags=["read-only"])
 async def ssl_mail_list():
     """
     List all mail SSL certificates.