New Adoption of Collection API
-
Discussion
-
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
Log in to reply.