RESTful API for Messages

[noorflex]

is there a json API which gives me list of all projects which i can display in my interface.

[vladak]

The existing web services (https://github.com/OpenGrok/OpenGrok/wiki/OpenGrok-web-services) are more tailored for searching. You can use Messages script to get the list of projects remotely however exposing the listening port to anyone is not a wise choice as this can be used to write configuration. Marking as enhancement - feel free to submit a pull req.

[vladak]

Ideally the code in ProjectMessage.java should be refactored and used for web services API.

[vladak]

Also, it's not clear to me whether currently the web services API is going through authorization code. @tulinkry ?

[vladak]

The other thing to solve is how to authorize the project (non-search) related requests. Pre-shared key passed in custom HTTP header ? Basic HTTP authentication serving as authorization ? Or allow anyone when coming from localhost ? I mean for super-user kind of access that could be used by indexing scripts.

[tulinkry]

It does the authorization

https://github.com/OpenGrok/OpenGrok/blob/7ccbd27804c2eaf410b0350e5a385587c941bb65/src/org/opensolaris/opengrok/web/JSONSearchServlet.java#L119-L123

and

https://github.com/OpenGrok/OpenGrok/blob/master/src/org/opensolaris/opengrok/search/SearchEngine.java#L259-L296

[noorflex]

Right, Existing web services are for searching, but to limit the scope of search to a subset of project (e.g one set of Branch out of many branches) will give more control to search.

[vladak]

Once this is addressed, the Python scripts under tools/scripts/ (in particular opengrok.py) should be changed to leverage the RESTful API instead of executing the Messages script.