Hi all,
Is there a changelog somewhere with noteable changes in the API? I could follow the Issue tracker I suppose, but curious if there's something like this https://developers.digitalocean.com/documentation/changelog/ for this API meant for human consumption.
Thanks! Scott
Hi Scott,
no there isn’t I’m afraid. We have been careful with changes to the public API which should have mostly been bug fixes, but sometimes minimal, backwards compatible changes creeped in too. The API has a major version number in the URL (v1) and we will change that version when including some proper changes, e.g. separating names and taxa in the API.
But I agree it would be good to also document the smaller changes, e.g. new entries to vocabularies used in searches. We could probably do that retrospectively by going through the commit history of the API project: https://github.com/gbif/gbif-api/commits/master https://github.com/gbif/gbif-api/commits/master
Do you think this is useful?
Markus
On 15 Sep 2015, at 22:43, Scott Chamberlain myrmecocystus@gmail.com wrote:
Hi all,
Is there a changelog somewhere with noteable changes in the API? I could follow the Issue tracker I suppose, but curious if there's something like this https://developers.digitalocean.com/documentation/changelog/ https://developers.digitalocean.com/documentation/changelog/ for this API meant for human consumption.
Thanks! Scott _______________________________________________ API-users mailing list API-users@lists.gbif.org http://lists.gbif.org/mailman/listinfo/api-users
Hi Markus,
Thanks for the detail on this. I think that would be useful, but I don't know how many others would benefit. If I'm the only one, I don't want to create extra work just for my benefit. If just me, I can just watch the commits on that repo you linked to.
Scott
On Wed, Sep 16, 2015 at 2:19 AM Markus Döring mdoering@gbif.org wrote:
Hi Scott,
no there isn’t I’m afraid. We have been careful with changes to the public API which should have mostly been bug fixes, but sometimes minimal, backwards compatible changes creeped in too. The API has a major version number in the URL (v1) and we will change that version when including some proper changes, e.g. separating names and taxa in the API.
But I agree it would be good to also document the smaller changes, e.g. new entries to vocabularies used in searches. We could probably do that retrospectively by going through the commit history of the API project: https://github.com/gbif/gbif-api/commits/master
Do you think this is useful?
Markus
On 15 Sep 2015, at 22:43, Scott Chamberlain myrmecocystus@gmail.com wrote:
Hi all,
Is there a changelog somewhere with noteable changes in the API? I could follow the Issue tracker I suppose, but curious if there's something like this https://developers.digitalocean.com/documentation/changelog/ for this API meant for human consumption.
Thanks! Scott
API-users mailing list API-users@lists.gbif.org http://lists.gbif.org/mailman/listinfo/api-users
Dear species API users,
we run into a serious performance problem with one of our API methods recently that does not support paging of results. It is the getRelated method here from the NameUsageService: http://gbif.github.io/gbif-api/apidocs/org/gbif/api/service/checklistbank/Na...
For example: http://api.gbif.org/v1/species/5231190/related
We would very much like to make that a pageable request, change the result type to PagingResponse<NameUsage> and add a nullable Pageable page parameter to the signature. We understand this is a breaking, not backwards compatible API change, but given that it can take down the entire species API we believe this warrants such a change without waiting for the next major API release (which won’t be this year for sure).
If this leads to serious problems for an existing API user please let us know. Otherwise we would like to take this change live rather soon, probably sometime early next week.
Thanks, Markus
-- Markus Döring Software Developer Global Biodiversity Information Facility (GBIF) mdoering@gbif.org http://www.gbif.org
participants (2)
-
Markus Döring -
Scott Chamberlain