From e11f4b17852ad8c6d4bc4372c62624a5845d25e4 Mon Sep 17 00:00:00 2001
From: Mohammad Torkashvand <mohammad.torkashvand@geant.org>
Date: Thu, 28 Mar 2024 14:42:05 +0100
Subject: [PATCH] added networks module to docs
---
docs/source/module/api/v1/index.rst | 1 +
docs/source/module/api/v1/networks.rst | 6 ++++++
gso/api/v1/network.py | 4 ++--
3 files changed, 9 insertions(+), 2 deletions(-)
create mode 100644 docs/source/module/api/v1/networks.rst
diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst
index 743e1a28..a40080e2 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 00000000..e85dda9e
--- /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 39889a33..c1e20368 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": []}
--
GitLab