The metadata-only deposit#

Goal#

A client may wish to deposit only metadata about an origin or object already present in the Software Heritage archive.

The metadata-only deposit is a special deposit where no content is provided and the data transferred to Software Heritage is only the metadata about an object in the archive.

Requirements#

  1. Create a metadata-only deposit through a POST request

  2. It is composed of ONLY one Atom XML document

  3. It MUST comply with the metadata requirements

  4. It MUST reference an object or an origin in a deposit tag

  5. The reference SHOULD exist in the SWH archive

  6. The object reference MUST be a SWHID on one of the following artifact types: - origin - snapshot - release - revision - directory - content

  7. The SWHID MAY be a core identifier with or without qualifiers

  8. The SWHID MUST NOT reference a fragment of code with the classifier lines

A complete metadata example#

The reference element is included in the metadata xml atomEntry under the swh namespace:

<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom"
       xmlns:codemeta="https://doi.org/10.5063/SCHEMA/CODEMETA-2.0"
       xmlns:swh="https://www.softwareheritage.org/schema/2018/deposit">
  <author>
    <name>HAL</name>
    <email>hal@ccsd.cnrs.fr</email>
  </author>
  <codemeta:name>The assignment problem</codemeta:name>
  <codemeta:url>https://hal.archives-ouvertes.fr/hal-01243573</codemeta:url>
  <codemeta:identifier>other identifier, DOI, ARK</codemeta:identifier>
  <codemeta:applicationCategory>Domain</codemeta:applicationCategory>
  <codemeta:description>description</codemeta:description>
  <codemeta:author>
    <codemeta:name>Author1</codemeta:name>
    <codemeta:affiliation>Inria</codemeta:affiliation>
    <codemeta:affiliation>UPMC</codemeta:affiliation>
  </codemeta:author>
  <codemeta:author>
    <codemeta:name>Author2</codemeta:name>
    <codemeta:affiliation>Inria</codemeta:affiliation>
    <codemeta:affiliation>UPMC</codemeta:affiliation>
  </codemeta:author>
  <swh:deposit>
    <swh:reference>
      <swh:origin url='https://github.com/user/repo'/>
    </swh:reference>
  </swh:deposit>
</entry>

References#

The metadata reference can be either on: - an origin - a graph object (core SWHID with or without qualifiers)

Origins#

The metadata may be on an origin, identified by the origin’s URL:

<swh:deposit>
  <swh:reference>
    <swh:origin url="https://github.com/user/repo" />
  </swh:reference>
</swh:deposit>

Graph objects#

It may also reference an object in the SWH graph: contents, directories, revisions, releases, and snapshots:

<swh:deposit>
  <swh:reference>
    <swh:object swhid="swh:1:dir:31b5c8cc985d190b5a7ef4878128ebfdc2358f49" />
  </swh:reference>
</swh:deposit>

<swh:deposit>
  <swh:reference>
    <swh:object swhid="swh:1:dir:31b5c8cc985d190b5a7ef4878128ebfdc2358f49;origin=https://hal.archives-ouvertes.fr/hal-01243573;visit=swh:1:snp:4fc1e36fca86b2070204bedd51106014a614f321;anchor=swh:1:rev:9c5de20cfb54682370a398fcc733e829903c8cba;path=/moranegg-AffectationRO-df7f68b/" />
  </swh:reference>
</swh:deposit>

The value of the swhid attribute must be a SWHID, with any context qualifiers in this list:

  • origin

  • visit

  • anchor

  • path

and they should be provided whenever relevant, especially origin.

Other qualifiers are not allowed (for example, line isn’t because SWH cannot store metadata at a finer level than entire contents).

Loading procedure#

In this case, the metadata-deposit will be injected as a metadata entry of the relevant object, with the information about the contributor of the deposit.