Document JSON view

djmitche · Feb 12, 2010 · 90e716b · 90e716b
1 parent a4b6965
commit 90e716b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/NEWS b/NEWS
@@ -3,6 +3,11 @@ Major User visible changes in Buildbot.             -*- outline -*-
 
 * Next Release (add significant changes here)
 
+* New /json web status
+
+This view has lots of useful information perfectly formed for serving as input
+to JavaScript status displays.  See /json/help for details.
+
 * Release 0.7.12 (January 21, 2010)
 
 ** New 'console' display

diff --git a/docs/buildbot.texinfo b/docs/buildbot.texinfo
@@ -7994,6 +7994,13 @@ This provides an atom feed summarizing all failed builds. The same
 query-arguments used by 'waterfall' can be added to filter the feed
 output.
 
+@item /json
+
+This view provides quick access to Buildbot status information in a form that
+is easiliy digested from other programs, including JavaScript.  See
+@code{/json/help} for detailed interactive documentation of the output formats
+for this view.
+
 @item /buildstatus?builder=$BUILDERNAME&number=$BUILDNUM
 
 This displays a waterfall-like chronologically-oriented view of all the