diff options
| author | David Lawrence <dkl@mozilla.com> | 2014-07-10 18:18:01 +0200 |
|---|---|---|
| committer | David Lawrence <dkl@mozilla.com> | 2014-07-10 18:18:01 +0200 |
| commit | 551eb6d2f6ed6da115b3ab51a966628ac445e29f (patch) | |
| tree | 1380688663ddc8eded059ed6a4b9879087f035d4 | |
| parent | 8dbd57d5cb91bdc1ab6f13018c2ca1163dddef82 (diff) | |
| download | bugzilla-551eb6d2f6ed6da115b3ab51a966628ac445e29f.tar.gz bugzilla-551eb6d2f6ed6da115b3ab51a966628ac445e29f.tar.xz | |
Bug 1036225: Return a link to the REST documentation in "method not found" errors
r=glob,a=glob
| -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 74062df63..d22eed063 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 bdc8365fc..2f1b80c45 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}) { |