Dear all,
this is an announcement of a new adoption of the Research Data Collections WG outputs. Our aim with this implementation is to provide a production-ready, general purpose Collection Service.
Our Collection Service covers all basic functionalities described in the final recommendations of the Data Collections WG, e.g.
Well-defined operations for collections and its members (create, read, update, delete).
Support for sub-collections.
Full support for all described collection capabilities (ordering, immutable collections, type and size restrictions).
Pagination support including navigation through ‘next’ and ‘prev’ attributes of result sets.
Support for basic operations (findMatch, flatten, union, intersection).
Besides that, there are some minor additions and changes with regard to the final recommendations:
Return type inconsistencies from the strawman, e.g. in /collections/{id}/members/{mid}, have been fixed.
Delete operations return HTTP NO_CONTENT (204) instead of HTTP OK (200) according to the HTTP standard.
Delete operations are implemented idempotent returning HTTP NO_CONTENT even if a resource has already been deleted.
ETag support has been added for production use in order to avoid concurrent modifications.
The code is publicly available on GitHub at https://github.com/kit-data-manager/collection-api under Apache 2 License.
Please feel free to checkout, to build the code and to test the Collection Service. If you face any issues, if you have ideas for improvement, or if you like to contribute, please use the issue tracker
or contact me directly.
Please also keep in mind, that the Collection Service is still under development, so things may change frequently until the first official release.
Regards,
Thomas.
--
Karlsruhe Institute of Technology (KIT)
Steinbuch Centre for Computing (SCC)
Dipl. Ing. Thomas Jejkal
Hermann-von-Helmholtz-Platz 1
76344 Eggenstein-Leopoldshafen, Germany
Phone: +49 721 608-24042
E-mail: ***@***.***
Web: http://www.scc.kit.edu
ORCID: http://orcid.org/0000-0003-2804-688X
Registered office: Kaiserstraße 12, 76133 Karlsruhe, Germany
KIT – The Research University in the Helmholtz Association
31
Jul
2019
Groups audience:
Author: Tobias Weigel
Date: 31 Jul, 2019
Dear Thomas, all,
I believe this is an excellent adoption effort that shows both that the
recommendation can be used effectively, but it also indicates that an
update of the recommendation or at least the API spec may be good.
Does it make sense to put this on the P15 agenda for a possible session
on adpoption and revising the spec?
Are there any other updates from new or ongoing adoption projects?
Please share!
Best, Tobias
On 31.7.2019, Tjejkal wrote:
Author: Thomas Zastrow
Date: 31 Jul, 2019
Dear all,
I agree with Tobias, it is really good to see further adoptions of the
collection API!
I would support another collection API WG session - @Tobias, Helsinki is
plenary 14, so you are talking already about the one in Australia? In
Helsinki, I'll participate, but there is only a small chance to be in
Australia.
Best,
Tom
Author: Tobias Weigel
Date: 31 Jul, 2019
Yes, I was considering P15, because the P14 program is already being
compiled and it is too late to hand in a session. We could, however,
also have a short discussion at the Data Fabric session if there is time
- may be a good alternative - but that session will also be quite booked.
Best, Tobias
On 31.7.2019, Thomas Zastrow wrote:
Dr. Tobias Weigel
Abteilung Datenmanagement
Deutsches Klimarechenzentrum GmbH (DKRZ)
Bundesstraße 45 a • 20146 Hamburg • Germany
Phone: +49 40 460094-431
Email: ***@***.***
URL: http://www.dkrz.de
ORCID: orcid.org/0000-0002-4040-0215
Geschäftsführer: Prof. Dr. Thomas Ludwig
Sitz der Gesellschaft: Hamburg
Amtsgericht Hamburg HRB 39784