958057 - REST API - No example of non-rewrite endpoint in POD docs, no config directions for how to create rewrite

Status: RESOLVED FIXED

(Bugzilla :: WebService, defect)

Description

[Dave Miller [:justdave]]

The "CONNECTING" section in the POD docs for Bugzilla::WebService::Server::REST currently shows the following:

>The endpoint for the REST interface is the rest.cgi script in your Bugzilla
>installation. If using Apache and mod_rewrite is installed and enabled, you can
>also use /rest/ as your endpoint. For example, if your Bugzilla is at
>bugzilla.yourdomain.com, then your REST client would access the API via:
>http://bugzilla.yourdomain.com/rest/bug/35 which looks cleaner.

1) What does an example URL look like if you're not using mod_rewrite?
2) How do I configure mod_rewrite if I want to use it? (What RewriteRule would I add?)

Comment 1

[Dave Miller [:justdave]]

I note that I can't really come up with my own RewriteRule if I don't know what the URL looks like without it that it needs to rewrite to.

rest.cgi/bug/35 ?
rest.cgi?method=bug&params={id:35} ?

Comment 2

[David Lawrence [:dkl]]

Good point. Patch coming.

Comment 3

[David Lawrence [:dkl]]

Attachment: 958057_1.patch

Comment 4

[Dave Miller [:justdave]]

Comment on attachment 8357845 [details] [diff] [review]
958057_1.patch

Works for me.  Thanks!

Comment 5

[David Lawrence [:dkl]]

Committing to: bzr+ssh://[e-mail]/bugzilla/trunk
modified Bugzilla/WebService/Server/REST.pm
Committed revision 8860.