Skip to content
Snippets Groups Projects
Commit ac955ba3 authored by Erik Reid's avatar Erik Reid
Browse files

started protocol section

parent 0596f6ac
No related branches found
No related tags found
No related merge requests found
......@@ -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
.. classifier endpoint docs
Classifier Endpoints
=========================
todo
.. 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
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