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

Update docstrings

parent a6140b3b
No related branches found
No related tags found
1 merge request!286Add Edge Port, GÉANT IP and IAS products
Pipeline #89883 passed
Showing
with 67 additions and 61 deletions
``gso.products.product_blocks.geant_ip``
========================================
.. automodule:: gso.products.product_blocks.geant_ip
:members:
:show-inheritance:
......@@ -16,9 +16,9 @@ Submodules
bgp_session
edge_port
geant_ip
iptrunk
lan_switch_interconnect
nren_l3_core_service
office_router
opengear
pop_vlan
......
``gso.workflows.geant_ip.create_imported_geant_ip``
``gso.products.product_blocks.nren_l3_core_service``
====================================================
.. automodule:: gso.workflows.geant_ip.create_imported_geant_ip
.. automodule:: gso.products.product_blocks.nren_l3_core_service
:members:
:show-inheritance:
``gso.products.product_types.geant_ip``
=======================================
.. automodule:: gso.products.product_types.geant_ip
:members:
:show-inheritance:
......@@ -15,9 +15,9 @@ Submodules
:maxdepth: 1
edge_port
geant_ip
iptrunk
lan_switch_interconnect
nren_l3_core_service
office_router
opengear
pop_vlan
......
``gso.products.product_types.nren_l3_core_service``
===================================================
.. automodule:: gso.products.product_types.nren_l3_core_service
:members:
:show-inheritance:
``gso.utils.types.country_code``
===============================
================================
.. automodule:: gso.utils.types.country_code
:members:
......
``gso.workflows.geant_ip.create_geant_ip``
==========================================
.. automodule:: gso.workflows.geant_ip.create_geant_ip
:members:
:show-inheritance:
``gso.workflows.geant_ip.import_geant_ip``
==========================================
.. automodule:: gso.workflows.geant_ip.import_geant_ip
:members:
:show-inheritance:
``gso.workflows.geant_ip``
==========================
.. automodule:: gso.workflows.geant_ip
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
create_geant_ip
create_imported_geant_ip
import_geant_ip
migrate_geant_ip
modify_geant_ip
``gso.workflows.geant_ip.migrate_geant_ip``
===========================================
.. automodule:: gso.workflows.geant_ip.migrate_geant_ip
:members:
:show-inheritance:
``gso.workflows.geant_ip.modify_geant_ip``
==========================================
.. automodule:: gso.workflows.geant_ip.modify_geant_ip
:members:
:show-inheritance:
......@@ -12,12 +12,12 @@ Subpackages
:maxdepth: 2
:titlesonly:
edge_port/index
iptrunk/index
nren_l3_core_service/index
office_router/index
opengear/index
router/index
site/index
super_pop_switch/index
tasks/index
edge_port/index
geant_ip/index
\ No newline at end of file
``gso.workflows.nren_l3_core_service.create_imported_nren_l3_core_service``
===========================================================================
.. automodule:: gso.workflows.nren_l3_core_service.create_imported_nren_l3_core_service
:members:
:show-inheritance:
``gso.workflows.nren_l3_core_service.create_nren_l3_core_service``
==================================================================
.. automodule:: gso.workflows.nren_l3_core_service.create_nren_l3_core_service
:members:
:show-inheritance:
``gso.workflows.nren_l3_core_service.import_nren_l3_core_service``
==================================================================
.. automodule:: gso.workflows.nren_l3_core_service.import_nren_l3_core_service
:members:
:show-inheritance:
``gso.workflows.nren_l3_core_service``
======================================
.. automodule:: gso.workflows.nren_l3_core_service
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
create_nren_l3_core_service
create_imported_nren_l3_core_service
import_nren_l3_core_service
migrate_nren_l3_core_service
modify_nren_l3_core_service
``gso.workflows.nren_l3_core_service.migrate_nren_l3_core_service``
===================================================================
.. automodule:: gso.workflows.nren_l3_core_service.migrate_nren_l3_core_service
:members:
:show-inheritance:
``gso.workflows.nren_l3_core_service.modify_nren_l3_core_service``
==================================================================
.. automodule:: gso.workflows.nren_l3_core_service.modify_nren_l3_core_service
:members:
:show-inheritance:
......@@ -254,7 +254,7 @@ def modify_existing_sbp_blocks(subscription: NRENL3CoreService, modified_sbp_lis
@step("Instantiate new Service Binding Ports")
def create_new_sbp_blocks(subscription: NRENL3CoreService, added_service_binding_ports: list[dict[str, Any]]) -> State:
"""Add new :term:`SBP`s to the :term:`NREN` L3 Core Service subscription."""
"""Add new two :term:`SBP` to the :term:`NREN` L3 Core Service subscription."""
for sbp_input in added_service_binding_ports:
edge_port = EdgePort.from_subscription(sbp_input["edge_port_id"])
bgp_session_list = [
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment