diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst index 743e1a2814efd7e63d07f87a8150b234eaaa909a..a40080e2019e321c1f4427fd41a0c58c564b5ba2 100644 --- a/docs/source/module/api/v1/index.rst +++ b/docs/source/module/api/v1/index.rst @@ -15,3 +15,4 @@ Submodules imports subscriptions processes + networks diff --git a/docs/source/module/api/v1/networks.rst b/docs/source/module/api/v1/networks.rst new file mode 100644 index 0000000000000000000000000000000000000000..e85dda9ead0424f293134cfba61a0429887c88bd --- /dev/null +++ b/docs/source/module/api/v1/networks.rst @@ -0,0 +1,6 @@ +``gso.api.v1.subscriptions`` +============================ + +.. automodule:: gso.api.v1.networks + :members: + :show-inheritance: diff --git a/gso/api/v1/network.py b/gso/api/v1/network.py index 39889a3338bcc318671cd6974b2ca017a43c8087..c1e20368944d1d8cd90d5d5dd8758afb9d109f66 100644 --- a/gso/api/v1/network.py +++ b/gso/api/v1/network.py @@ -11,7 +11,7 @@ from starlette import status from gso.products.product_blocks.iptrunk import PhysicalPortCapacity from gso.services.subscriptions import get_active_iptrunk_subscriptions -router = APIRouter(prefix="/networks", tags=["Network"],) +router = APIRouter(prefix="/networks", tags=["Network"]) class RouterBlock(OrchestratorBaseModel): @@ -59,7 +59,7 @@ def _calculate_iptrunk_capacity(iptrunk_sides: list, iptrunk_speed: PhysicalPort return f"{capacity}G" -@router.get("/topology", status_code=status.HTTP_200_OK, response_model=NetworkTopologyDomainModelSchema,) +@router.get("/topology", status_code=status.HTTP_200_OK, response_model=NetworkTopologyDomainModelSchema) def network_topology() -> NetworkTopologyDomainModelSchema: """Retrieve all active or provisioning IP trunk subscriptions.""" topology: dict = {"iptrunks": []}