diff --git a/docs/source/protocol/classifier.rst b/docs/source/protocol/classifier.rst deleted file mode 100644 index 06729f244634fb9c1911c6507aa7c9a03c61e01a..0000000000000000000000000000000000000000 --- a/docs/source/protocol/classifier.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. classifier endpoint docs - - -Classifier Endpoints -========================= - -These endpoints are intended for use by Dashboard V3. - -.. contents:: :local: - -/classifier/peer-info ---------------------- - -.. autofunction:: inventory_provider.routes.classifier.get_bgp_peer_info - -/classifier/juniper-link-info ------------------------------ - -.. autofunction:: inventory_provider.routes.classifier.get_juniper_link_info - - -/classifier/infinera-lambda-info --------------------------------- - -.. autofunction:: inventory_provider.routes.classifier.get_infinera_lambda_info - - -/classifier/infinera-fiberlink-info ------------------------------------- - -.. autofunction:: - inventory_provider.routes.classifier.get_fiberlink_trap_metadata - -/classifier/coriant-info ------------------------- - -.. autofunction:: inventory_provider.routes.classifier.get_coriant_info - - -/classifier/mtc-interface-info --------------------------------- - -.. autofunction:: inventory_provider.routes.classifier.get_mtc_interface_info diff --git a/docs/source/protocol/index.rst b/docs/source/protocol/index.rst index 370ec063c4bf9dc13791577bc6a37c8bc81070ab..d861e71d28b6b266ba41381be1dbfc05afffaeb2 100644 --- a/docs/source/protocol/index.rst +++ b/docs/source/protocol/index.rst @@ -28,11 +28,12 @@ API modules :maxdepth: 2 :caption: Contents: - classifier lg data jobs msr lnetd +.. automodule:: inventory_provider.routes.classifier + .. automodule:: inventory_provider.routes.poller diff --git a/inventory_provider/routes/classifier.py b/inventory_provider/routes/classifier.py index f470dd3393c58b94fccec10a0597b388b5b16757..6d27c8a081c398aec98ade4aac42647ef0dd00fe 100644 --- a/inventory_provider/routes/classifier.py +++ b/inventory_provider/routes/classifier.py @@ -1,3 +1,45 @@ +""" +Classifier Endpoints +========================= + +These endpoints are intended for use by Dashboard V3. + +.. contents:: :local: + +/classifier/peer-info +--------------------- + +.. autofunction:: inventory_provider.routes.classifier.get_bgp_peer_info + +/classifier/juniper-link-info +----------------------------- + +.. autofunction:: inventory_provider.routes.classifier.get_juniper_link_info + + +/classifier/infinera-lambda-info +-------------------------------- + +.. autofunction:: inventory_provider.routes.classifier.get_infinera_lambda_info + + +/classifier/infinera-fiberlink-info +------------------------------------ + +.. autofunction:: + inventory_provider.routes.classifier.get_fiberlink_trap_metadata + +/classifier/coriant-info +------------------------ + +.. autofunction:: inventory_provider.routes.classifier.get_coriant_info + + +/classifier/mtc-interface-info +-------------------------------- + +.. autofunction:: inventory_provider.routes.classifier.get_mtc_interface_info +""" import ipaddress import json import logging