From ee5c3380dfce764317ab84f389e6be7d6fe7cb59 Mon Sep 17 00:00:00 2001
From: Ralph Bean <rbean@redhat.com>
Date: Sep 16 2017 11:17:32 +0000
Subject: Document the version endpoint.


I noticed we don't have a sample http response for this endpoint.
Should probably have one.

---

diff --git a/greenwave/api_v1.py b/greenwave/api_v1.py
index 267f926..771ee55 100644
--- a/greenwave/api_v1.py
+++ b/greenwave/api_v1.py
@@ -14,7 +14,24 @@ requests_session = requests.Session()
 
 @api.route('/version', methods=['GET'])
 def version():
-    """ Returns the current running version. """
+    """ Returns the current running version.
+
+    **Sample response**:
+
+    .. sourcecode:: http
+
+       HTTP/1.0 200
+       Content-Length: 228
+       Content-Type: application/json
+       Date: Thu, 16 Mar 2017 17:42:04 GMT
+       Server: Werkzeug/0.12.1 Python/2.7.13
+
+       {
+           'version': '1.2.3'
+       }
+
+    :statuscode 200: Currently running greenwave software version is returned.
+    """
     resp = jsonify({'version': __version__})
     resp = insert_headers(resp)
     resp.status_code = 200