[tor-commits] [metrics-web/master] Document build_revision fields in CollecTor/Onionoo.

[karsten at torproject.org]

commit c1c2f3baebba2054d29b0e59301f3233928602a3
Author: Karsten Loesing <karsten.loesing at gmx.net>
Date:   Mon Oct 9 17:28:49 2017 +0200

    Document build_revision fields in CollecTor/Onionoo.
---
 website/src/main/resources/web/WEB-INF/collector.jsp |  1 +
 website/src/main/resources/web/WEB-INF/onionoo.jsp   | 13 +++++++++++++
 2 files changed, 14 insertions(+)

diff --git a/website/src/main/resources/web/WEB-INF/collector.jsp b/website/src/main/resources/web/WEB-INF/collector.jsp
index 871415c..92f6c7c 100644
--- a/website/src/main/resources/web/WEB-INF/collector.jsp
+++ b/website/src/main/resources/web/WEB-INF/collector.jsp
@@ -734,6 +734,7 @@ Index files use the following custom JSON data format that might still be extend
 <li>Index object: At the document root there is always an index object with the following fields:
 <ul>
 <li><code>"index_created"</code>: Timestamp when this index was created using pattern <code>"YYYY-MM-DD HH:MM"</code> in the UTC timezone.</li>
+<li><code>"build_revision"</code>: Git revision of the CollecTor instance's software used to create this file, which will be omitted if unknown.</li>
 <li><code>"path"</code>: Base URL of this index file and all included resources.</li>
 <li><code>"files"</code>: List of file objects of files available from the document root, which will be omitted if empty.
 <li><code>"directories"</code>: List of directory objects of directories available from the document root, which will be omitted if empty.</li>
diff --git a/website/src/main/resources/web/WEB-INF/onionoo.jsp b/website/src/main/resources/web/WEB-INF/onionoo.jsp
index 4f4c68f..71f8336 100644
--- a/website/src/main/resources/web/WEB-INF/onionoo.jsp
+++ b/website/src/main/resources/web/WEB-INF/onionoo.jsp
@@ -230,6 +230,8 @@ February 28, 2017.</li>
 <li><strong>4.1</strong>: Added "version" parameter and removed bridge
 clients objects' beta fields "countries", "transports", and "versions"
 on August 30, 2017.</li>
+<li><strong>4.2</strong>: Added "build_revision" field to response header
+on October 10, 2017.</li>
 </ul>
 
 
@@ -604,6 +606,17 @@ Omitted if no major protocol changes are planned.
 </li>
 
 <li>
+<b>build_revision <span class="label label-primary">new</span></b>
+<code class="typeof">string</code>
+<span class="required-false">optional</span>
+<p>
+Git revision of the Onionoo instance's software used to write this
+response, which will be omitted if unknown.
+<span class="blue">Added on October 10, 2017.</span>
+</p>
+</li>
+
+<li>
 <b>relays_published</b>
 <code class="typeof">string</code>
 <span class="required-true">required</span>