From d2db7cb5c43d8b7866b30ba856d03aea9f09eac8 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Fri, 11 Oct 2024 14:58:55 +0200
Subject: [PATCH] Add missing terms to glossary
---
docs/source/glossary.rst | 7 +++++++
gso/products/product_blocks/bgp_session.py | 4 ++--
gso/products/product_blocks/edge_port.py | 2 +-
3 files changed, 10 insertions(+), 3 deletions(-)
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index 40512a3f..59b699e5 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -90,6 +90,10 @@ Glossary of terms
OSS
Operational Support Systems
+ SBP
+ Service Binding Point, a logical construct used in the orchestrator to attach a partner subscription to a physical
+ (set of) ports.
+
SDP
Service Demarcation Point: A logical construct used for modeling partner subscriptions. It models the link between
the physical and the service domains.
@@ -107,5 +111,8 @@ Glossary of terms
VLAN
Virtual LAN
+ WAN
+ Wide Area Network
+
WFO
`Workflow Orchestrator <https://workfloworchestrator.org/>`_
diff --git a/gso/products/product_blocks/bgp_session.py b/gso/products/product_blocks/bgp_session.py
index b952f181..65c5f0a0 100644
--- a/gso/products/product_blocks/bgp_session.py
+++ b/gso/products/product_blocks/bgp_session.py
@@ -11,7 +11,7 @@ from gso.utils.types.ip_address import IPAddress
@strawberry.enum
class IPFamily(strEnum):
- """Possible :term:`IP` families of a :term:`BGP` peering."""
+ """Possible IP families of a :term:`BGP` peering."""
V4UNICAST = "v4unicast"
V6UNICAST = "v6unicast"
@@ -64,7 +64,7 @@ class BGPSession(BGPSessionProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE
bfd_interval: int | None = None
#: The :term:`BFD` multiplier, if enabled.
bfd_multiplier: int | None = None
- #: The list of :term:`IP` families enabled for this session.
+ #: The list of IP families enabled for this session.
families: list[IPFamily]
#: Whether any custom policies exist for this session.
has_custom_policies: bool
diff --git a/gso/products/product_blocks/edge_port.py b/gso/products/product_blocks/edge_port.py
index d8228a89..c78719e2 100644
--- a/gso/products/product_blocks/edge_port.py
+++ b/gso/products/product_blocks/edge_port.py
@@ -106,7 +106,7 @@ class EdgePortBlock(EdgePortBlockProvisioning, lifecycle=[SubscriptionLifecycle.
edge_port_enable_lacp: bool
#: The type of encapsulation used on this edge port, by default DOT1Q.
edge_port_encapsulation: EncapsulationType = EncapsulationType.DOT1Q
- #: The :term:`MAC` address assigned to this edge port, if applicable.
+ #: The MAC address assigned to this edge port, if applicable.
edge_port_mac_address: str | None = None
#: The speed capacity of each member in the physical port.
edge_port_member_speed: PhysicalPortCapacity
--
GitLab