From 8aaa68861d105c1971e36b10cbfafff9e45626a1 Mon Sep 17 00:00:00 2001 From: Erik Reid <erik.reid@geant.org> Date: Tue, 16 Feb 2021 13:14:37 +0100 Subject: [PATCH] docs --- docs/source/protocol/msr.rst | 30 ++++++++++++++++++++++++++++-- inventory_provider/routes/msr.py | 2 +- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/docs/source/protocol/msr.rst b/docs/source/protocol/msr.rst index 112a7113..12eb41ee 100644 --- a/docs/source/protocol/msr.rst +++ b/docs/source/protocol/msr.rst @@ -14,7 +14,33 @@ These endpoints are intended for use by MSR. .. autofunction:: inventory_provider.routes.msr.access_services -/msr/logical-system-peerings</name> +/msr/bgp/logical-systems ------------------------------------- -.. autofunction:: inventory_provider.routes.msr.logical_system_peerings \ No newline at end of file +.. autofunction:: inventory_provider.routes.msr.get_logical_systems + + +/msr/bgp/logical-system-peerings</name> +------------------------------------------ + +.. autofunction:: inventory_provider.routes.msr.logical_system_peerings + + +/msr/bgp/groups +------------------------------------- + +.. autofunction:: inventory_provider.routes.msr.get_peering_groups + + +/msr/bgp/group-peerings</name> +------------------------------------- + +.. autofunction:: inventory_provider.routes.msr.bgp_group_peerings + + +helpers +------------------------------------- + +.. autofunction:: inventory_provider.routes.msr._handle_peering_group_list_request + +.. autofunction:: inventory_provider.routes.msr._handle_peering_group_request diff --git a/inventory_provider/routes/msr.py b/inventory_provider/routes/msr.py index f4c03200..62e25212 100644 --- a/inventory_provider/routes/msr.py +++ b/inventory_provider/routes/msr.py @@ -138,7 +138,7 @@ def _handle_peering_group_request(name, cache_key, group_key_base): .. asjson:: inventory_provider.routes.msr.PEERING_LIST_SCHEMA - :param name: group/logical-system name, nor None + :param name: group/logical-system name, or None :param cache_key: base cache key for this type of request :param group_key_base: key above which the peerings are grouped :return: a json list, formatted as above -- GitLab