Add product description endpoint

Author: rambo

src/rmfpapi/api/__init__.py

@@ -5,9 +5,12 @@
 from .clientinfo import router as clientinfo_router
 from .admininfo import router as admininfo_router
 from .healthcheck import router as healthcheck_router
+from .description import router as description_router
+
 
 all_routers = APIRouter()
 all_routers.include_router(usercrud_router, prefix="/users", tags=["users"])
 all_routers.include_router(clientinfo_router, prefix="/clients", tags=["clients"])
 all_routers.include_router(admininfo_router, prefix="/admins", tags=["admins"])
 all_routers.include_router(healthcheck_router, prefix="/healthcheck", tags=["healthcheck"])
+all_routers.include_router(description_router, prefix="/description", tags=["description"])

src/rmfpapi/api/admininfo.py

@@ -13,7 +13,7 @@
 router = APIRouter(dependencies=[Depends(MTLSHeader(auto_error=True))])
 
 
-@router.get("/fragment")
+@router.get("/fragment", deprecated=True)
 async def admin_instruction_fragment() -> UserInstructionFragment:
     """Return user instructions, we use POST because the integration layer might not keep
     track of callsigns and certs by UUID and will probably need both for the instructions"""

src/rmfpapi/api/clientinfo.py

@@ -22,7 +22,7 @@ def zip_pem(pem: str, filename: str) -> bytes:
     return zip_buffer.getvalue()
 
 
-@router.post("/fragment")
+@router.post("/fragment", deprecated=True)
 async def client_instruction_fragment(user: UserCRUDRequest) -> List[Dict[str, str]]:
     """Return user instructions, we use POST because the integration layer might not keep
     track of callsigns and certs by UUID and will probably need both for the instructions"""

src/rmfpapi/api/description.py

@@ -0,0 +1,43 @@
+"""Descriptions API"""
+from typing import Optional
+import logging
+
+from fastapi import APIRouter
+from pydantic import BaseModel, Extra, Field  # pylint: disable=(no-name-in-module # false-positive
+
+LOGGER = logging.getLogger(__name__)
+
+router = APIRouter()  # These endpoints are public
+
+
+# FIXME: Move to libpvarki
+class ProductDescription(BaseModel):  # pylint: disable=too-few-public-methods
+    """Description of a product"""
+
+    shortname: str = Field(description="Short name for the product, used as slug/key in dicts and urls")
+    title: str = Field(description="Fancy name for the product")
+    icon: Optional[str] = Field(description="URL for icon")
+    description: str = Field(description="Short-ish description of the product")
+    language: str = Field(description="Language of this response")
+
+    class Config:  # pylint: disable=too-few-public-methods
+        """Pydantic configs"""
+
+        extra = Extra.forbid
+
+
+@router.get(
+    "/{language}",
+    response_model=ProductDescription,
+    deprecated=True,
+)
+async def return_product_description(language: str) -> ProductDescription:
+    """Fetch description from each product in manifest"""
+    _ = language
+    return ProductDescription(
+        shortname="fake",
+        title="Fake Product",
+        icon=None,
+        description="Fake product for integrations testing and examples",
+        language="en",
+    )

tests/test_description.py

@@ -0,0 +1,17 @@
+"""Test description endpoint"""
+import logging
+
+import pytest
+from fastapi.testclient import TestClient
+
+LOGGER = logging.getLogger(__name__)
+
+
+@pytest.mark.parametrize("lang", ["en", "fi"])
+def test_get_description(mtlsclient: TestClient, lang: str) -> None:
+    """Check getting the description"""
+    resp = mtlsclient.get(f"api/v1/description/{lang}")
+    assert resp.status_code == 200
+    payload = resp.json()
+    assert payload["shortname"] == "fake"
+    assert payload["language"] == "en"