From d6eb9dbef455aaa076ee479ec67fd5c6b47306ed Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Fri, 23 Feb 2024 17:05:04 +0100
Subject: [PATCH] Update documentation to include missing workflow entries
---
docs/source/glossary.rst | 3 +++
docs/source/module/workflows/router/activate_router.rst | 6 ++++++
docs/source/module/workflows/router/index.rst | 3 +++
.../source/module/workflows/router/redeploy_base_config.rst | 6 ++++++
docs/source/module/workflows/router/update_ibgp_mesh.rst | 6 ++++++
gso/services/subscriptions.py | 2 +-
6 files changed, 25 insertions(+), 1 deletion(-)
create mode 100644 docs/source/module/workflows/router/activate_router.rst
create mode 100644 docs/source/module/workflows/router/redeploy_base_config.rst
create mode 100644 docs/source/module/workflows/router/update_ibgp_mesh.rst
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index 0bbcce27..432f73de 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -51,6 +51,9 @@ Glossary of terms
NET
Network Entity Title: used for :term:`ISIS` routing.
+ OOB
+ Out-of-band access
+
OSS
Operational Support Systems
diff --git a/docs/source/module/workflows/router/activate_router.rst b/docs/source/module/workflows/router/activate_router.rst
new file mode 100644
index 00000000..383502dd
--- /dev/null
+++ b/docs/source/module/workflows/router/activate_router.rst
@@ -0,0 +1,6 @@
+``gso.workflows.router.activate_router``
+========================================
+
+.. automodule:: gso.workflows.router.activate_router
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/router/index.rst b/docs/source/module/workflows/router/index.rst
index 11c3f71c..e582a440 100644
--- a/docs/source/module/workflows/router/index.rst
+++ b/docs/source/module/workflows/router/index.rst
@@ -12,5 +12,8 @@ Submodules
:maxdepth: 2
:titlesonly:
+ activate_router
create_router
+ redeploy_base_config
terminate_router
+ update_ibgp_mesh
diff --git a/docs/source/module/workflows/router/redeploy_base_config.rst b/docs/source/module/workflows/router/redeploy_base_config.rst
new file mode 100644
index 00000000..1348f983
--- /dev/null
+++ b/docs/source/module/workflows/router/redeploy_base_config.rst
@@ -0,0 +1,6 @@
+``gso.workflows.router.redeploy_base_config``
+=============================================
+
+.. automodule:: gso.workflows.router.redeploy_base_config
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/router/update_ibgp_mesh.rst b/docs/source/module/workflows/router/update_ibgp_mesh.rst
new file mode 100644
index 00000000..213aacb7
--- /dev/null
+++ b/docs/source/module/workflows/router/update_ibgp_mesh.rst
@@ -0,0 +1,6 @@
+``gso.workflows.router.update_ibgp_mesh``
+=========================================
+
+.. automodule:: gso.workflows.router.update_ibgp_mesh
+ :members:
+ :show-inheritance:
diff --git a/gso/services/subscriptions.py b/gso/services/subscriptions.py
index e739546b..e77b8d7b 100644
--- a/gso/services/subscriptions.py
+++ b/gso/services/subscriptions.py
@@ -85,7 +85,7 @@ def get_active_router_subscriptions(includes: list[str] | None = None) -> list[S
def get_provisioning_router_subscriptions(includes: list[str] | None = None) -> list[SubscriptionType]:
"""Retrieve provisioning subscriptions specifically for routers.
- :param list[str] | None includes: The fields to be included in the returned Subscription objects.
+ :param list[str] includes: The fields to be included in the returned Subscription objects.
:return list[Subscription]: A list of router Subscription objects.
"""
return get_subscriptions(product_type="Router", lifecycle=SubscriptionLifecycle.PROVISIONING, includes=includes)
--
GitLab