From ac955ba360b6a3a272eddce32381466a87ed6476 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Sun, 24 Jan 2021 13:35:22 +0100
Subject: [PATCH] started protocol section
---
docs/source/index.rst | 13 ++-----------
docs/source/protocol/classifier.rst | 8 ++++++++
docs/source/protocol/index.rst | 29 +++++++++++++++++++++++++++++
3 files changed, 39 insertions(+), 11 deletions(-)
create mode 100644 docs/source/protocol/classifier.rst
create mode 100644 docs/source/protocol/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
index a8524be3..d91d8575 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -9,17 +9,7 @@ Inventory Provider
Documentation for Inventory Provider.
This service acts as a single point of truth for
information about the GÉANT network, exposed by
-a Flask-based web service.
-
-The webservice 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.
+by an HTTP API.
.. toctree::
@@ -27,3 +17,4 @@ and www.json.org for more details.
:caption: Contents:
configuration
+ protocol/index
\ No newline at end of file
diff --git a/docs/source/protocol/classifier.rst b/docs/source/protocol/classifier.rst
new file mode 100644
index 00000000..70db45d1
--- /dev/null
+++ b/docs/source/protocol/classifier.rst
@@ -0,0 +1,8 @@
+.. classifier endpoint docs
+
+
+Classifier Endpoints
+=========================
+
+
+todo
diff --git a/docs/source/protocol/index.rst b/docs/source/protocol/index.rst
new file mode 100644
index 00000000..93a5664c
--- /dev/null
+++ b/docs/source/protocol/index.rst
@@ -0,0 +1,29 @@
+.. 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.
+
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ classifier
+
+
+Version
+-------------
+
+.. autofunction:: inventory_provider.routes.default.version
+
--
GitLab