From 56267560e1e74086c48553d4f4e235391bf657b4 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 20 Sep 2023 10:12:09 +0200
Subject: [PATCH] Add docstrings to new IP trunk and router fields
---
lso/routes/ip_trunk.py | 3 +++
lso/routes/router.py | 2 ++
2 files changed, 5 insertions(+)
diff --git a/lso/routes/ip_trunk.py b/lso/routes/ip_trunk.py
index e1efb9f..8798cbc 100644
--- a/lso/routes/ip_trunk.py
+++ b/lso/routes/ip_trunk.py
@@ -19,7 +19,9 @@ class IPTrunkParams(BaseModel):
callback: HttpUrl
#: A dictionary representation of the IP trunk subscription that is to be provisioned.
subscription: dict
+ #: Trouble Ticket number that is associated with the deployment.
tt_number: str
+ #: The process ID generated by workflow orchestrator, used for the commit comment in the routers.
process_id: str
@@ -54,6 +56,7 @@ class IPTrunkMigrationParams(IPTrunkParams):
new_side: dict
#: An Ansible playbook verb that is passed along for indicating the phase of the migration that is performed.
verb: str
+ #: The type of object that is migrated.
config_object: str
diff --git a/lso/routes/router.py b/lso/routes/router.py
index 05f99df..b9895c3 100644
--- a/lso/routes/router.py
+++ b/lso/routes/router.py
@@ -30,7 +30,9 @@ class NodeProvisioningParams(BaseModel):
#: Whether this playbook execution should be a dry run, or run for real. Defaults to ``True`` for obvious reasons,
#: also making it an optional parameter.
dry_run: Optional[bool] = True
+ #: Trouble Ticket number that is associated with the deployment.
tt_number: str
+ #: The process ID generated by workflow orchestrator, used for the commit comment in the routers.
process_id: str
--
GitLab