From: David Lawrence <dkl@mozilla.com>
Date: Thu, 10 Jul 2014 16:18:01 +0000 (+0000)
Subject: Bug 1036225: Return a link to the REST documentation in "method not found" errors
X-Git-Tag: bugzilla-4.5.5~7
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=551eb6d2f6ed6da115b3ab51a966628ac445e29f;p=thirdparty%2Fbugzilla.git

Bug 1036225: Return a link to the REST documentation in "method not found" errors
r=glob,a=glob
---

diff --git a/Bugzilla/Constants.pm b/Bugzilla/Constants.pm
index 74062df630..d22eed063c 100644
--- a/Bugzilla/Constants.pm
+++ b/Bugzilla/Constants.pm
@@ -18,6 +18,7 @@ use Memoize;
 
 @Bugzilla::Constants::EXPORT = qw(
     BUGZILLA_VERSION
+    REST_DOC
 
     REMOTE_FILE
     LOCAL_FILE
@@ -198,6 +199,10 @@ use Memoize;
 # Bugzilla version
 use constant BUGZILLA_VERSION => "4.5.4+";
 
+# A base link to the current REST Documentation. We place it here
+# as it will need to be updated to whatever the current release is.
+use constant REST_DOC => "http://www.bugzilla.org/docs/tip/en/html/api/";
+
 # Location of the remote and local XML files to track new releases.
 use constant REMOTE_FILE => 'http://updates.bugzilla.org/bugzilla-update.xml';
 use constant LOCAL_FILE  => 'bugzilla-update.xml'; # Relative to datadir.
diff --git a/Bugzilla/WebService/Server/REST.pm b/Bugzilla/WebService/Server/REST.pm
index bdc8365fce..2f1b80c45d 100644
--- a/Bugzilla/WebService/Server/REST.pm
+++ b/Bugzilla/WebService/Server/REST.pm
@@ -120,6 +120,7 @@ sub response {
     if (exists $json_data->{error}) {
         $result = $json_data->{error};
         $result->{error} = $self->type('boolean', 1);
+        $result->{documentation} = REST_DOC;
         delete $result->{'name'}; # Remove JSONRPCError
     }
     elsif (exists $json_data->{result}) {