Skip to content
Snippets Groups Projects
Commit 56267560 authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

Add docstrings to new IP trunk and router fields

parent d1310d2e
No related branches found
No related tags found
1 merge request!45Migrate iptrunks ansible integration
Pipeline #84073 passed
...@@ -19,7 +19,9 @@ class IPTrunkParams(BaseModel): ...@@ -19,7 +19,9 @@ class IPTrunkParams(BaseModel):
callback: HttpUrl callback: HttpUrl
#: A dictionary representation of the IP trunk subscription that is to be provisioned. #: A dictionary representation of the IP trunk subscription that is to be provisioned.
subscription: dict subscription: dict
#: Trouble Ticket number that is associated with the deployment.
tt_number: str tt_number: str
#: The process ID generated by workflow orchestrator, used for the commit comment in the routers.
process_id: str process_id: str
...@@ -54,6 +56,7 @@ class IPTrunkMigrationParams(IPTrunkParams): ...@@ -54,6 +56,7 @@ class IPTrunkMigrationParams(IPTrunkParams):
new_side: dict new_side: dict
#: An Ansible playbook verb that is passed along for indicating the phase of the migration that is performed. #: An Ansible playbook verb that is passed along for indicating the phase of the migration that is performed.
verb: str verb: str
#: The type of object that is migrated.
config_object: str config_object: str
......
...@@ -30,7 +30,9 @@ class NodeProvisioningParams(BaseModel): ...@@ -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, #: 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. #: also making it an optional parameter.
dry_run: Optional[bool] = True dry_run: Optional[bool] = True
#: Trouble Ticket number that is associated with the deployment.
tt_number: str tt_number: str
#: The process ID generated by workflow orchestrator, used for the commit comment in the routers.
process_id: str process_id: str
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment