diff options
author | David Lawrence <dkl@mozilla.com> | 2014-07-10 18:21:02 +0200 |
---|---|---|
committer | David Lawrence <dkl@mozilla.com> | 2014-07-10 18:21:02 +0200 |
commit | 741b17a136754d0808de08154ca923459f87e2e3 (patch) | |
tree | ca91fc45398d4f7e2ebcdc40e561707a764910eb /Bugzilla | |
parent | fb10b4ad7063064c4a520d9767324ddcc245f85b (diff) | |
download | bugzilla-741b17a136754d0808de08154ca923459f87e2e3.tar.gz bugzilla-741b17a136754d0808de08154ca923459f87e2e3.tar.xz |
Bug 1036225: Return a link to the REST documentation in "method not found" errors
Diffstat (limited to 'Bugzilla')
-rw-r--r-- | Bugzilla/Constants.pm | 5 | ||||
-rw-r--r-- | Bugzilla/WebService/Server/REST.pm | 1 |
2 files changed, 6 insertions, 0 deletions
diff --git a/Bugzilla/Constants.pm b/Bugzilla/Constants.pm index ce5a06286..a37638705 100644 --- a/Bugzilla/Constants.pm +++ b/Bugzilla/Constants.pm @@ -39,6 +39,7 @@ use Memoize; @Bugzilla::Constants::EXPORT = qw( BUGZILLA_VERSION + REST_DOC REMOTE_FILE LOCAL_FILE @@ -214,6 +215,10 @@ use Memoize; # Bugzilla version use constant BUGZILLA_VERSION => "4.2.9+"; +# 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 1be457c8f..69f97ef08 100644 --- a/Bugzilla/WebService/Server/REST.pm +++ b/Bugzilla/WebService/Server/REST.pm @@ -129,6 +129,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}) { |