news about REST API changes

Added by Alex Last over 7 years ago

Hi everybody! I'm working on an application to import data from Redmine through its REST API. I see some changes were done in the API lately: http://www.redmine.org/wiki/redmine/Rest_Issues/diff?version=3&version_from=2&commit=View+differences

is there a good way to be notified about all changes in REST API? I mean, except for subscribing to all possible wiki pages manually. do we have a dev mail list or something? or maybe we could post these news somewhere via RSS.

I want to update my Redmine Java API before users start submitting bug reports that it does not work anymore.

Replies (10)

RE: news about REST API changes - Added by Felix Schäfer over 7 years ago

Alexey Skor wrote:

is there a good way to be notified about all changes in REST API? I mean, except for subscribing to all possible wiki pages manually. do we have a dev mail list or something? or maybe we could post these news somewhere via RSS.

Changes in trunk are not to be considered stable, only once they are committed to one of the stable branches, and in that case the release notes will make mention of it. If you run trunk, you must already be aware that changes to it won't be announced in advance, if you want information about what is happening there, grab the repository ATOM feed, if you want to make sure your application still works with current trunk, install it on a staging server and test it before going live with it.

RE: news about REST API changes - Added by Alex Last over 7 years ago

ok, makes sense. thanks.

RE: news about REST API changes - Added by Eric Davis over 7 years ago

Alexey Skor:

I consider the REST API very beta at this point (even in the "stable" branches). The code is well tested but until people start building on top of the API and give use feedback on how it's working, it will be in flux.

That said, I have several plans to start integrating Redmine into my other business systems soon. These integrations should start to really stress the API and help find its limitations and areas to improve.

Eric Davis

RE: news about REST API changes - Added by Alex Last about 7 years ago

What would be nice to have in Redmine REST API is ability to get a list of projects and saved queries.

RE: news about REST API changes - Added by Alex Last about 7 years ago

correction: I found the API to get list of projects (although was surprised to see that all projects were returned, including the ones the user was not assigned to. looks like a security issue).

RE: news about REST API changes - Added by Mischa The Evil about 7 years ago

Alexey Skor wrote:

[...] (although was surprised to see that all projects were returned, including the ones the user was not assigned to. looks like a security issue).

Not exactly. See Rest_Projects#Authentication for an explanation of it.
Also see Rest_api for more general API-information.

two API improvements: "manage saved queries" and "validate API access" - Added by Alex Last about 7 years ago

Thanks, I see. I changed projects to be not "public" and they are not shown without authentication anymore.

I read "rest api" docs and can't see how I could get list of saved queries for a user.

Another suggestion I have is to have some "pinger" api so I could verify the host name and API key are valid. I tried getting list of projects for such validation, but the problem is that in some cases this request can timeout, e.g. this is what happens with demo.redmine.org site with plenty of projects (thousands?):
java.io.IOException: Server returned HTTP response code: 502 for URL: http://demo.redmine.org/projects.xml

My guess is that projects list is too long and demo.redmine.org server is too slow. Retrieving list of projects can potentially be a long-running operation, while what I need for my GUI application is "Are this host and API access key valid?"

RE: two API improvements: "manage saved queries" and "validate API access" - Added by Eric Davis about 7 years ago

Alexey Skor:

I read "rest api" docs and can't see how I could get list of saved queries for a user.

If it's not documented, it's not implemented. There are still a lot of areas of Redmine you can't access with the API.

Another suggestion I have is to have some "pinger" api

It would be best to open a feature request for the "pinger" API. I've created a few for non-Redmine apps and I can reuse that code easily.

Eric Davis

RE: news about REST API changes - Added by Alex Last about 7 years ago

ok, I submitted "check status" feature request: http://www.redmine.org/issues/5977

RE: news about REST API changes - Added by Alex Last about 7 years ago

I submitted one more feature request about REST API, which I believe is very important for the users:

#5997 REST API should provide valid xml response with status for EVERY request

(1-10/10)