diff --git a/docs/source/index.rst b/docs/source/index.rst index 973f14658ae332ceb0b6b67213c6fc59c9284487..beefa098163aee5d9d7fba0f32b444c8b9394b36 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,4 +17,5 @@ by an HTTP API. :caption: Contents: configuration - protocol \ No newline at end of file + protocol + diff --git a/docs/source/protocol.rst b/docs/source/protocol.rst index 46a321ff36544be3a2f6d72ee6aad2f3cbd60e30..1fc5e408f8ba2651f9e10220532610c38e6efae5 100644 --- a/docs/source/protocol.rst +++ b/docs/source/protocol.rst @@ -1,36 +1,2 @@ -.. protocol intro -Protocol -========================= - -This module implements a Flask-based webservice which -communicates with clients over HTTP. -Responses to valid requests are returned as JSON messages. -The server will therefore return an error unless -``application/json`` is in the ``Accept`` request header field. - -HTTP communication and JSON grammar details are -beyond the scope of this document. -Please refer to `RFC 2616 <https://tools.ietf.org/html/rfc2616>`_ -and www.json.org for more details. - -.. contents:: :local: - - -.. automodule:: inventory_provider.routes.default - -.. automodule:: inventory_provider.routes.classifier - -.. automodule:: inventory_provider.routes.poller - -.. automodule:: inventory_provider.routes.msr - -.. automodule:: inventory_provider.routes.lg - -.. automodule:: inventory_provider.routes.lnetd - -.. automodule:: inventory_provider.routes.data - -.. automodule:: inventory_provider.routes.jobs - -.. automodule:: inventory_provider.routes.neteng +.. automodule:: inventory_provider.routes diff --git a/inventory_provider/routes/__init__.py b/inventory_provider/routes/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..fc1766c94e433a29fb893ba4e349f3e8427fa01a 100644 --- a/inventory_provider/routes/__init__.py +++ b/inventory_provider/routes/__init__.py @@ -0,0 +1,39 @@ +""" +.. protocol intro + +Protocol +========================= + +This module implements a Flask-based webservice which +communicates with clients over HTTP. +Responses to valid requests are returned as JSON messages. +The server will therefore return an error unless +``application/json`` is in the ``Accept`` request header field. + +HTTP communication and JSON grammar details are +beyond the scope of this document. +Please refer to `RFC 2616 <https://tools.ietf.org/html/rfc2616>`_ +and www.json.org for more details. + +.. contents:: :local: + + +.. automodule:: inventory_provider.routes.default + +.. automodule:: inventory_provider.routes.classifier + +.. automodule:: inventory_provider.routes.poller + +.. automodule:: inventory_provider.routes.msr + +.. automodule:: inventory_provider.routes.lg + +.. automodule:: inventory_provider.routes.lnetd + +.. automodule:: inventory_provider.routes.data + +.. automodule:: inventory_provider.routes.jobs + +.. automodule:: inventory_provider.routes.neteng + +""" \ No newline at end of file diff --git a/inventory_provider/routes/classifier.py b/inventory_provider/routes/classifier.py index 49192830307e136b7ab774e694fcc6dedc11ffa6..39a44c77c358c3366755fead15c37c3dc570b6b4 100644 --- a/inventory_provider/routes/classifier.py +++ b/inventory_provider/routes/classifier.py @@ -47,7 +47,7 @@ These endpoints are intended for use by Dashboard V3. /classifier/router-info/<equimpent-name> --------------------------------- +------------------------------------------- .. autofunction:: inventory_provider.routes.classifier.get_router_info