From 4d5ffbc03e51bcb2b247f79f15466ca45d0e298e Mon Sep 17 00:00:00 2001 From: Stefan Stammberger Date: Tue, 5 Oct 2021 19:50:32 +0200 Subject: [PATCH] refactor: Shorten the url path of get ln info lite old: /lightning/get-ln-info-lite new: /lightning/get-info-lite --- app/routers/lightning.py | 34 ++++++++++++++++----------------- tests/routers/test_lightning.py | 8 ++++---- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/app/routers/lightning.py b/app/routers/lightning.py index f679e7f..04d88cb 100644 --- a/app/routers/lightning.py +++ b/app/routers/lightning.py @@ -27,23 +27,6 @@ _PREFIX = "lightning" router = APIRouter(prefix=f"/{_PREFIX}", tags=["Lightning"]) -@router.get( - "/get-ln-info-lite", - name=f"{_PREFIX}.get-ln-info-lite", - summary="Get current lightning system status", - dependencies=[Depends(JWTBearer())], - status_code=status.HTTP_200_OK, - response_model=LightningInfoLite, -) -async def get_ln_info_lite_path(): - try: - return await get_ln_info_lite() - except HTTPException as r: - raise HTTPException(r.status_code, detail=r.reason) - except NotImplementedError as r: - raise HTTPException(status.HTTP_501_NOT_IMPLEMENTED, detail=r.args[0]) - - @router.post( "/add-invoice", name=f"{_PREFIX}.add-invoice", @@ -135,6 +118,23 @@ async def get_info(): raise HTTPException(status.HTTP_501_NOT_IMPLEMENTED, detail=r.args[0]) +@router.get( + "/get-info-lite", + name=f"{_PREFIX}.get-info-lite", + summary="Get lightweight current lightning info. Less verbose version of /lightning/get-info", + dependencies=[Depends(JWTBearer())], + status_code=status.HTTP_200_OK, + response_model=LightningInfoLite, +) +async def get_ln_info_lite_path(): + try: + return await get_ln_info_lite() + except HTTPException as r: + raise HTTPException(r.status_code, detail=r.reason) + except NotImplementedError as r: + raise HTTPException(status.HTTP_501_NOT_IMPLEMENTED, detail=r.args[0]) + + @router.get( "/decode-pay-req", name=f"{_PREFIX}.decode-pay-req", diff --git a/tests/routers/test_lightning.py b/tests/routers/test_lightning.py index 6c670b2..b8deff2 100644 --- a/tests/routers/test_lightning.py +++ b/tests/routers/test_lightning.py @@ -9,7 +9,7 @@ from .test_lightning_utils import get_valid_lightning_info_lite def test_route_authentications_latest(test_client: TestClient): prefix = "/latest/lightning" - response = test_client.get(f"{prefix}/get-ln-info-lite") + response = test_client.get(f"{prefix}/get-info-lite") assert response.status_code == status.HTTP_403_FORBIDDEN response = test_client.post(f"{prefix}/add-invoice", params={"value_msat": 1337}) @@ -36,7 +36,7 @@ def test_route_authentications_latest(test_client: TestClient): def test_route_authentications_v1(test_client: TestClient): prefix = "/v1/lightning" - response = test_client.get(f"{prefix}/get-ln-info-lite") + response = test_client.get(f"{prefix}/get-info-lite") assert response.status_code == status.HTTP_403_FORBIDDEN response = test_client.post(f"{prefix}/add-invoice", params={"value_msat": 1337}) @@ -72,13 +72,13 @@ def test_get_ln_status(test_client: TestClient, monkeypatch): monkeypatch.setattr(lightning, "get_ln_info_lite", mock_get_ln_info_lite) - response = test_client.get(f"{prefix_latest}/get-ln-info-lite") + response = test_client.get(f"{prefix_latest}/get-info-lite") r_js = response.json() v_js = get_valid_lightning_info_lite().dict() assert r_js == v_js - response = test_client.get(f"{prefix_v1}/get-ln-info-lite") + response = test_client.get(f"{prefix_v1}/get-info-lite") r_js = response.json() v_js = get_valid_lightning_info_lite().dict() assert r_js == v_js