Categories
News Repositories SWORD v3

SWORDV3 at Open Repositories 2018

We will be running a SWORDV3 Workshop at Open Repositories 2018 (June 4-7, in Bozeman, Montana). Currently, we are scheduled for 9-12pm on Monday 4th.

The workshop will go through the technical specification in detail, followed by a discussion on Community and sustainability plans for the future.

Hope to see you there!

Categories
News SWORD v3

SWORDV3 Final Candidate (Hopefully) Spec Released

The final draft of the SWORD V3 Technical Specification has been released for comment. You can find them in the SWORD V3 of this website along with guidance for reading the documents and other supporting materials.

To comment, please contact us to get onto the stakeholders list – details can be found here.

Categories
SWORD v3

Happy New Year

Happy New Year, hope you all had a great Christmas.

Over December and the first half of January, we’ve been working through the comments and our email discussions to produce a new iteration of the specification for review.  It’s still by no means a finished work, so there’s plenty more scope for alterations, additions and removals!

The new version is here: https://docs.google.com/document/d/1eQL1Guv0ihfxPJIIceLJk4l22cRpGbXTsNVSNqcEdOM/edit

The following summarises the changes that we’ve made:

  • Expanded all the protocol operations, especially to include their error codes, and reformatted them to remove the confusing table layout
  • Removed the “Add File to Content” protocol operation, as no longer necessary
  • Added support for concurrency control, using ETag and If-Match headers.
  • Added some definitions for the URLs and Document types for ease of use
  • Expanded all the JSON-LD context headers for the 4 document types
  • Provided field documentation for all the document types, and extended those fields as needed based on the comments/discussion on the first iteration of the spec.
  • Expanded the section on Authentication and Authorisation based on our email discussion
  • Expanded the section on File Segment Upload based on comments in the documentation and further analysis of the problem
  • Expanded the section on By Reference Deposit to bring it into line with similar behaviours to the File Segment Upload
  • Expanded the Packaging section to define the 3 core formats: Binary, SimpleZip and SWORDBagIt.  For SWORDBagIt, we evaluated the RDA spec, and have produced something similar, but not complaint with, that profile.
  • Added an example on how to deposit metadata formats other than the default sword format.

There’s a fair bit to look at, so I’ll leave that to sit with you for a week or so, and for you to add any comments you like to the doc, and then as before we’ll pick some key topics for discussion on this list.

To avoid any confusion, I have now disabled commenting on the old version.  Most comments on the old version were resolved, and I’ve carried forward any comments which are still relevant.

All the best,

Richard

Categories
News SWORD v3

SWORDV3 Community Discussion Document

A SWORD Community Discussion document has been released for comment. You can find them in the SWORD V3 section of this website along previously released technical documentation.

To comment, please contact us to get onto the stakeholders list – details can be found an earlier previous post. We aim to start developing some firmer community recommendations in the new year.

Categories
News SWORD v3

SWORD V3 First Drafts

The first drafts of the SWORD V3 Technical Specification have been released for comment. You can find them in the SWORD V3 of this website along with guidance for reading the documents and other supporting materials.

To comment, please contact us to get onto the stakeholders list – details can be found in the previous post. We aim to start work on a revised spec, taking into account your feedback, bythe end of the year.

 

Categories
News SWORD v3

SWORDv3 Stakeholders Call

The SWORDV3 project has been funded by Jisc with two key aims for the next generation of the SWORD Protocol:

  • To bring SWORD up-to-date with the developments in the repository sphere in the last 5 years, with alignment to new protocols and new use-cases such as data publishing and complex objects.
  • To establish community and governance mechanisms for the standard and supporting code libraries to ensure ongoing maintenance and evolution. This will include a technical validation process to allow third party libraries to be hosted under the SWORD brand.

in September, the project was formally announced at PASIG 2017 in Oxford and the RDA 10th Plenary in Montreal. We are looking for expressions of interest in becoming involved as stakeholders in the project: to make suggestions, review activities and meet as required over the coming months. In particular, we are interested in making contact with people who may wish to develop SWORD V3 libraries for their preferred platforms or languages since we aim to provide some support for such activities during the project. Please contact one of the project team  if you are interested in participating, and indicate if you are interested in the technical or community aspects of the project (or both!).

The key members of the project team are:

On the technical side, we are creating a document that brings together the change requests and new use cases that have collected since the release of SWORDV2, culled from the github site, message posts and preliminary discussions with some stakeholders earlier this year. This has also suggested a way forward that breaks with SWORD’s AtomPub roots in order to provide a more up-to-date and flexible protocol. We will circulate this to stakeholders soon.

On the community side, we will circulate a similar document outlining possible models for developing the SWORD community in the future. This is a much more open set of choices since the SWORD user-base has expanded considerably since its first conception, and we are open to further suggestions! The final arrangements must be aligned with community wishes in order to be an effective sustainable solution.

Neil Jefferies (neil.jefferies[at]bodleian.ox.ac.uk) @NeilSJefferies
Dom Fripp (dom.fripp[at]jisc.ac.uk) @Domicus
Richard Jones (richard[at]cottagelabs.com) @cottagelabs