API Documentation

This is Software Heritage’s SWORD 2.0 Server implementation.

S.W.O.R.D (Simple Web-Service Offering Repository Deposit) is an interoperability standard for digital file deposit.

This implementation will permit interaction between a client (a repository) and a server (SWH repository) to push deposits of software source code archives with associated metadata.

Note:

  • In the following document, we will use the archive or software source code archive interchangeably.

  • The supported archive formats are:

    • zip: common zip archive (no multi-disk zip files).

    • tar: tar archive without compression or optionally any of the following compression algorithm gzip (.tar.gz, .tgz), bzip2 (.tar.bz2) , or lzma (.tar.lzma)

Collection

SWORD defines a collection concept. In SWH’s case, this collection refers to a group of deposits. A deposit is some form of software source code archive(s) associated with metadata. By default the client’s collection will have the client’s name.

Limitations

  • upload limitation of 100Mib

  • no mediation

API overview

API access is over HTTPS.

The API is protected through basic authentication.

Endpoints

The API endpoints are rooted at https://deposit.softwareheritage.org/1/.

Data is sent and received as XML (as specified in the SWORD 2.0 specification).

Possible errors: